C-CDA on FHIR
1.1.0 - (FHIR R4) STU Release 1.1

This page is part of the C-CDA on FHIR Implementation Guide (v1.1.0: STU 1.1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: US Realm Header

Defining URL:http://hl7.org/fhir/us/ccda/StructureDefinition/US-Realm-Header
Version:1.1.0
Name:USRealmHeader
Title:US Realm Header
Status:Active as of 2020-10-21T22:01:58+00:00
Definition:

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.

Publisher:HL7 Structured Documents Working Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/ccda/StructureDefinition/US-Realm-Header

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Clinical Document

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*Clinical DocumentThis is an abstract profile
A set of resources composed into a single coherent clinical statement with clinical attestation
... language S1..1codelanguage
... VersionNumber S0..1integerExtension
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumber
... DataEntererExtension S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)Extension
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/DataEntererExtension
... InformationRecipientExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile)informationRecipient
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/InformationRecipientExtension
... ParticipantExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)participant
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/ParticipantExtension
... PerformerExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)performer
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/PerformerExtension
... AuthorizationExtension S0..*Reference(Consent)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/AuthorizationExtension
... OrderExtension S0..*Reference(ServiceRequest)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/OrderExtension
... identifier S1..1Identifieridentifier
... type S1..1CodeableConceptKind of composition (LOINC if possible)
... subject S0..1Reference(US Core Patient Profile | Group)Who and/or what the composition is about
... encounter S0..1Reference(US Core Encounter Profile)Context of the Composition
... date S1..1dateTimedate
... author S1..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson)Who and/or what authored the composition
... title S1..1stringDocument Title
... confidentiality 0..0
... attester 0..*(Slice Definition)Attests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:legal_attester S0..1BackboneElementattester
..... mode S1..1codemode
Fixed Value: legal
..... party S1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)party
.... attester:professional_attester S0..*BackboneElementattester
..... mode S1..1codemode
Fixed Value: professional
..... party S1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)party
.... attester:personal_attester S0..*BackboneElementattester
..... mode S1..1codemode
Fixed Value: personal
..... party S1..1Reference(US Core Patient Profile | RelatedPerson)party
... custodian S1..1Reference(US Core Organization Profile)custodian

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*Clinical DocumentThis is an abstract profile
A set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language S1..1codelanguage
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... composition-clinicaldocument-versionNumber 0..*stringVersion-specific identifier for composition
URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber
... VersionNumber S0..1integerExtension
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumber
... DataEntererExtension S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)Extension
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/DataEntererExtension
... InformantExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)informant
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/InformantExtension
... InformationRecipientExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile)informationRecipient
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/InformationRecipientExtension
... ParticipantExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)participant
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/ParticipantExtension
... PerformerExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)performer
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/PerformerExtension
... AuthorizationExtension S0..*Reference(Consent)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/AuthorizationExtension
... OrderExtension S0..*Reference(ServiceRequest)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/OrderExtension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1Identifieridentifier
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type SΣ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred)
... category Σ0..*CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example)
... subject SΣ0..1Reference(US Core Patient Profile | Group)Who and/or what the composition is about
... encounter SΣ0..1Reference(US Core Encounter Profile)Context of the Composition
... date SΣ1..1dateTimedate
... author SΣ1..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson)Who and/or what authored the composition
... title SΣ1..1stringDocument Title
... attester 0..*(Slice Definition)Attests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required)
..... time 0..1dateTimeWhen the composition was attested
..... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the composition
.... attester:legal_attester S0..1BackboneElementattester
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode S1..1codemode
Binding: CompositionAttestationMode (required)
Fixed Value: legal
..... time 0..1dateTimeWhen the composition was attested
..... party S1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)party
.... attester:professional_attester S0..*BackboneElementattester
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode S1..1codemode
Binding: CompositionAttestationMode (required)
Fixed Value: professional
..... time 0..1dateTimeWhen the composition was attested
..... party S1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)party
.... attester:personal_attester S0..*BackboneElementattester
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode S1..1codemode
Binding: CompositionAttestationMode (required)
Fixed Value: personal
..... time 0..1dateTimeWhen the composition was attested
..... party S1..1Reference(US Core Patient Profile | RelatedPerson)party
... custodian SΣ1..1Reference(US Core Organization Profile)custodian
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... event Σ0..*BackboneElementThe clinical service(s) being documented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example)
.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... section I0..*BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example)
.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
.... text I0..1NarrativeText summary of the section, for human interpretation
.... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred)
.... entry I0..*Reference(Resource)A reference to data that supports this section
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred)
.... section I0..*See sectionNested Section

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*Clinical DocumentThis is an abstract profile
A set of resources composed into a single coherent clinical statement with clinical attestation
... language 1..1codelanguage
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... VersionNumber 0..1integerExtension
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumber
... DataEntererExtension 0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)Extension
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/DataEntererExtension
... InformationRecipientExtension 0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile)informationRecipient
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/InformationRecipientExtension
... ParticipantExtension 0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)participant
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/ParticipantExtension
... PerformerExtension 0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)performer
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/PerformerExtension
... AuthorizationExtension 0..*Reference(Consent)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/AuthorizationExtension
... OrderExtension 0..*Reference(ServiceRequest)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/OrderExtension
... identifier Σ1..1Identifieridentifier
... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred)
... subject Σ0..1Reference(US Core Patient Profile | Group)Who and/or what the composition is about
... encounter Σ0..1Reference(US Core Encounter Profile)Context of the Composition
... date Σ1..1dateTimedate
... author Σ1..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson)Who and/or what authored the composition
... title Σ1..1stringDocument Title
... attester:legal_attester 0..1BackboneElementattester
.... mode 1..1codemode
Binding: CompositionAttestationMode (required)
Fixed Value: legal
.... party 1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)party
... attester:professional_attester 0..*BackboneElementattester
.... mode 1..1codemode
Binding: CompositionAttestationMode (required)
Fixed Value: professional
.... party 1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)party
... attester:personal_attester 0..*BackboneElementattester
.... mode 1..1codemode
Binding: CompositionAttestationMode (required)
Fixed Value: personal
.... party 1..1Reference(US Core Patient Profile | RelatedPerson)party
... custodian Σ1..1Reference(US Core Organization Profile)custodian

doco Documentation for this format

Differential View

This structure is derived from Clinical Document

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*Clinical DocumentThis is an abstract profile
A set of resources composed into a single coherent clinical statement with clinical attestation
... language S1..1codelanguage
... VersionNumber S0..1integerExtension
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumber
... DataEntererExtension S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)Extension
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/DataEntererExtension
... InformationRecipientExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile)informationRecipient
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/InformationRecipientExtension
... ParticipantExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)participant
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/ParticipantExtension
... PerformerExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)performer
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/PerformerExtension
... AuthorizationExtension S0..*Reference(Consent)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/AuthorizationExtension
... OrderExtension S0..*Reference(ServiceRequest)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/OrderExtension
... identifier S1..1Identifieridentifier
... type S1..1CodeableConceptKind of composition (LOINC if possible)
... subject S0..1Reference(US Core Patient Profile | Group)Who and/or what the composition is about
... encounter S0..1Reference(US Core Encounter Profile)Context of the Composition
... date S1..1dateTimedate
... author S1..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson)Who and/or what authored the composition
... title S1..1stringDocument Title
... confidentiality 0..0
... attester 0..*(Slice Definition)Attests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:legal_attester S0..1BackboneElementattester
..... mode S1..1codemode
Fixed Value: legal
..... party S1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)party
.... attester:professional_attester S0..*BackboneElementattester
..... mode S1..1codemode
Fixed Value: professional
..... party S1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)party
.... attester:personal_attester S0..*BackboneElementattester
..... mode S1..1codemode
Fixed Value: personal
..... party S1..1Reference(US Core Patient Profile | RelatedPerson)party
... custodian S1..1Reference(US Core Organization Profile)custodian

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*Clinical DocumentThis is an abstract profile
A set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language S1..1codelanguage
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... composition-clinicaldocument-versionNumber 0..*stringVersion-specific identifier for composition
URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber
... VersionNumber S0..1integerExtension
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumber
... DataEntererExtension S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)Extension
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/DataEntererExtension
... InformantExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)informant
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/InformantExtension
... InformationRecipientExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile)informationRecipient
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/InformationRecipientExtension
... ParticipantExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)participant
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/ParticipantExtension
... PerformerExtension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)performer
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/PerformerExtension
... AuthorizationExtension S0..*Reference(Consent)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/AuthorizationExtension
... OrderExtension S0..*Reference(ServiceRequest)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/OrderExtension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1Identifieridentifier
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type SΣ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred)
... category Σ0..*CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example)
... subject SΣ0..1Reference(US Core Patient Profile | Group)Who and/or what the composition is about
... encounter SΣ0..1Reference(US Core Encounter Profile)Context of the Composition
... date SΣ1..1dateTimedate
... author SΣ1..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson)Who and/or what authored the composition
... title SΣ1..1stringDocument Title
... attester 0..*(Slice Definition)Attests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required)
..... time 0..1dateTimeWhen the composition was attested
..... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the composition
.... attester:legal_attester S0..1BackboneElementattester
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode S1..1codemode
Binding: CompositionAttestationMode (required)
Fixed Value: legal
..... time 0..1dateTimeWhen the composition was attested
..... party S1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)party
.... attester:professional_attester S0..*BackboneElementattester
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode S1..1codemode
Binding: CompositionAttestationMode (required)
Fixed Value: professional
..... time 0..1dateTimeWhen the composition was attested
..... party S1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)party
.... attester:personal_attester S0..*BackboneElementattester
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode S1..1codemode
Binding: CompositionAttestationMode (required)
Fixed Value: personal
..... time 0..1dateTimeWhen the composition was attested
..... party S1..1Reference(US Core Patient Profile | RelatedPerson)party
... custodian SΣ1..1Reference(US Core Organization Profile)custodian
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... event Σ0..*BackboneElementThe clinical service(s) being documented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example)
.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... section I0..*BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example)
.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
.... text I0..1NarrativeText summary of the section, for human interpretation
.... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred)
.... entry I0..*Reference(Resource)A reference to data that supports this section
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred)
.... section I0..*See sectionNested Section

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Composition.languagepreferredCommonLanguages
Max Binding: AllLanguages
Composition.statusrequiredCompositionStatus
Composition.typepreferredFHIRDocumentTypeCodes
Composition.categoryexampleDocumentClassValueSet
Composition.attester.moderequiredCompositionAttestationMode
Composition.attester:legal_attester.moderequiredFixed Value: legal
Composition.attester:professional_attester.moderequiredFixed Value: professional
Composition.attester:personal_attester.moderequiredFixed Value: personal
Composition.relatesTo.coderequiredDocumentRelationshipType
Composition.event.codeexamplev3.ActCode
Composition.section.codeexampleDocumentSectionCodes
Composition.section.moderequiredListMode
Composition.section.orderedBypreferredListOrderCodes
Composition.section.emptyReasonpreferredListEmptyReasons

Constraints

IdPathDetailsRequirements
dom-2CompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3CompositionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4CompositionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5CompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6CompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1Composition.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extension:versionNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.extension:versionNumberMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extension:version_number_extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.extension:version_number_extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extension:data_enterer_extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.extension:data_enterer_extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extension:informant_extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.extension:informant_extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extension:information_recipient_extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.extension:information_recipient_extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extension:participant_extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.extension:participant_extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extension:performer_extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.extension:performer_extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extension:authorization_extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.extension:authorization_extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extension:order_extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.extension:order_extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attesterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.attester.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.attester.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.attester.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.attester.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester.timeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester.partyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester:legal_attesterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester:legal_attester.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.attester:legal_attester.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.attester:legal_attester.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.attester:legal_attester.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.attester:legal_attester.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester:legal_attester.timeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester:legal_attester.partyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester:professional_attesterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester:professional_attester.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.attester:professional_attester.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.attester:professional_attester.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.attester:professional_attester.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.attester:professional_attester.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester:professional_attester.timeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester:professional_attester.partyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester:personal_attesterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester:personal_attester.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.attester:personal_attester.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.attester:personal_attester.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.attester:personal_attester.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.attester:personal_attester.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester:personal_attester.timeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.attester:personal_attester.partyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.custodianAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.relatesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.relatesTo.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.relatesTo.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.relatesTo.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.relatesTo.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.relatesTo.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.relatesTo.target[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.eventAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.event.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.event.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.event.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.event.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.event.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.event.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.event.detailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
cmp-1Composition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2Composition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
ele-1Composition.sectionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.section.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.section.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.section.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Composition.section.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.section.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.section.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.section.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.section.focusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.section.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.section.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.section.orderedByAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.section.entryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.section.emptyReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Composition.section.sectionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())