PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.us.core@8.0.0
    http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference
description: The US Core DocumentReference Profile inherits from the FHIR [DocumentReference](https://hl7.org/fhir/R4/documentreference.html) resource; refer to it for scope and usage definitions. This profile sets minimum expectations for searching and fetching patient documents including Clinical Notes using the DocumentReference resource.  It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption. Before reviewing this profile, implementers are encouraged to read the Clinical Notes Guidance to understand the overlap of the US Core DiagnosticReport Profile for Report and Note exchange and the US Core DocumentReference Profile.
package_name: hl7.fhir.us.core
derivation: constraint
name: USCoreDocumentReferenceProfile
type: DocumentReference
elements:
  category:
    mustSupport: true
    index: 3
    slicing:
      rules: open
      discriminator:
      - {path: $this, type: value}
      min: 1
      slices:
        uscore:
          match: {}
          schema:
            short: '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Categorization of document'
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category'}
            index: 4
  date: {mustSupport: true, index: 6}
  content:
    mustSupport: true
    index: 8
    elements:
      attachment:
        constraint:
          us-core-6: {human: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present., severity: error, expression: url.exists() or data.exists()}
        mustSupport: true
        index: 9
        elements:
          contentType: {mustSupport: true, index: 10}
          data: {mustSupport: true, index: 11}
          url: {mustSupport: true, index: 12}
      format:
        binding: {strength: extensible, valueSet: 'http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes|2.1.0'}
        mustSupport: true
        index: 13
  type:
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type'}
    mustSupport: true
    index: 2
  author:
    type: Reference
    mustSupport: true
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson']
    index: 7
  status:
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/document-reference-status'}
    mustSupport: true
    index: 1
  identifier: {mustSupport: true, index: 0}
  context:
    mustSupport: true
    index: 14
    elements:
      encounter:
        type: Reference
        mustSupport: true
        refers: ['http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter']
        index: 15
      period: {mustSupport: true, index: 16}
  subject:
    type: Reference
    mustSupport: true
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient']
    index: 5
package_version: 8.0.0
class: profile
kind: resource
url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference
base: http://hl7.org/fhir/StructureDefinition/DocumentReference
version: 8.0.0
required: [category, subject, type]