description: This profile defines constraints that represent common administrative and demographic concepts for US Realm clinical documents. Further specification, such as type, are provided in document profiles that conform to this profile.
package_name: hl7.fhir.us.ccda
derivation: constraint
name: USRealmHeader
abstract: true
type: Composition
elements:
  date: {short: date, mustSupport: true, index: 13}
  encounter:
    type: Reference
    mustSupport: true
    refers: ['http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter']
    index: 12
  attester:
    mustSupport: false
    index: 17
    slicing:
      rules: open
      discriminator:
      - {path: mode, type: value}
      min: null
      slices:
        legal_attester:
          match: {mode: legal}
          schema:
            short: attester
            mustSupport: true
            index: 18
            elements:
              mode:
                short: mode
                pattern: {type: Code, value: legal}
                mustSupport: true
                index: 19
              party:
                type: Reference
                short: party
                mustSupport: true
                refers: ['http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole']
                index: 20
            required: [party]
        professional_attester:
          match: {mode: professional}
          schema:
            short: attester
            mustSupport: true
            index: 21
            elements:
              mode:
                short: mode
                pattern: {type: Code, value: professional}
                mustSupport: true
                index: 22
              party:
                type: Reference
                short: party
                mustSupport: true
                refers: ['http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole']
                index: 23
            required: [party]
        personal_attester:
          match: {mode: personal}
          schema:
            short: attester
            mustSupport: true
            index: 24
            elements:
              mode:
                short: mode
                pattern: {type: Code, value: personal}
                mustSupport: true
                index: 25
              party:
                type: Reference
                short: party
                mustSupport: true
                refers: ['http://hl7.org/fhir/StructureDefinition/RelatedPerson', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient']
                index: 26
            required: [party]
  type: {mustSupport: true, index: 10}
  title: {label: Document Title, short: Document Title, mustSupport: true, index: 15}
  author:
    type: Reference
    mustSupport: true
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson', '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']
    index: 14
  extension:
    type: Extension
    mustSupport: true
    url: http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumber
    index: 1
    slicing:
      slices:
        version_number_extension:
          match: {}
          schema: {type: Extension, mustSupport: true, url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumber', index: 1}
          max: 1
        data_enterer_extension:
          match: {}
          schema: {type: Extension, mustSupport: true, url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/DataEntererExtension', index: 2}
          max: 1
        informant_extension:
          match: {}
          schema: {type: Extension, label: informant, short: informant, mustSupport: true, url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/InformantExtension', index: 3}
        information_recipient_extension:
          match: {}
          schema: {type: Extension, label: informationRecipient, short: informationRecipient, mustSupport: true, url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/InformationRecipientExtension', index: 4}
        participant_extension:
          match: {}
          schema: {type: Extension, label: participant, short: participant, mustSupport: true, url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/ParticipantExtension', index: 5}
        performer_extension:
          match: {}
          schema: {type: Extension, label: performer, short: performer, mustSupport: true, url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/PerformerExtension', index: 6}
        authorization_extension:
          match: {}
          schema: {type: Extension, label: authorization, short: authorization, mustSupport: true, url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/AuthorizationExtension', index: 7}
        order_extension:
          match: {}
          schema: {type: Extension, label: authorization, short: authorization, mustSupport: true, url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/OrderExtension', index: 8}
  custodian:
    type: Reference
    label: custodian
    short: custodian
    mustSupport: true
    refers: ['http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization']
    index: 27
  language: {short: language, mustSupport: true, index: 0}
  identifier: {short: identifier, mustSupport: true, index: 9}
  subject:
    type: Reference
    mustSupport: true
    refers: ['http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient']
    index: 11
  confidentiality: {label: Use the confidentiality codes in Meta.security, short: Use the confidentiality codes in Meta.security, mustSupport: false, index: 16}
package_version: 2.0.0-ballot
extensions:
  version_number_extension: {url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumber', max: 1, type: Extension, mustSupport: true, index: 1}
  data_enterer_extension: {url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/DataEntererExtension', max: 1, type: Extension, mustSupport: true, index: 2}
  informant_extension: {url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/InformantExtension', type: Extension, label: informant, short: informant, mustSupport: true, index: 3}
  information_recipient_extension: {url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/InformationRecipientExtension', type: Extension, label: informationRecipient, short: informationRecipient, mustSupport: true, index: 4}
  participant_extension: {url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/ParticipantExtension', type: Extension, label: participant, short: participant, mustSupport: true, index: 5}
  performer_extension: {url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/PerformerExtension', type: Extension, label: performer, short: performer, mustSupport: true, index: 6}
  authorization_extension: {url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/AuthorizationExtension', type: Extension, label: authorization, short: authorization, mustSupport: true, index: 7}
  order_extension: {url: 'http://hl7.org/fhir/us/ccda/StructureDefinition/OrderExtension', type: Extension, label: authorization, short: authorization, mustSupport: true, index: 8}
class: profile
kind: resource
url: http://hl7.org/fhir/us/ccda/StructureDefinition/US-Realm-Header
base: http://hl7.org/fhir/StructureDefinition/clinicaldocument
version: 2.0.0-ballot
required: [identifier, custodian, language]