STU 1 Ballot

This page is part of the C-CDA on FHIR Implementation Guide (v1.6.0: STU 1 Ballot 1) based on FHIR v1.6.0. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: ccda-us-realm-header-composition

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/ccda/StructureDefinition/ccda-us-realm-header-composition

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.

This profile was published on Thu Aug 11 21:16:47 AEST 2016 as a draft by Lantana Consulting Group.

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

Example yet to be done.

This structure is derived from Composition

Summary

Mandatory: 13 elements (+2 nested mandatory elements)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Composition.attester is sliced based on the value of Composition.attester.mode

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*
... language 1..1codelanguage
... identifier 1..1Identifieridentifier
... date 1..1dateTimedate
... type 1..1CodeableConceptDocument Type
... title 1..1stringDocument Title
... status 1..1codestatus
... confidentiality 1..1codeconfidentiality
Binding: HL7 BasicConfidentialityKind (required)
... subject 1..1Reference(Profile daf-core-patient)recordTarget
... author 1..*Reference(Profile daf-core-pract | http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-core-device)author
... attester BackboneElementSlice: Unordered, Open, by Composition.attester.mode
... attester 0..*BackboneElementlegalAuthenticator
.... mode 1..*codemode
Fixed Value: legal
.... party 0..1Reference(Profile daf-core-pract)party
... attester 0..*BackboneElementauthenticator
.... mode 1..*codemode
.... party 0..1Reference(Profile daf-core-pract)party
... custodian 1..1Reference(Profile daf-core-organization)custodian
... event 1..*BackboneElementserviceEvent
.... period 1..1Periodperiod
..... start 1..1dateTimestart
... encounter 0..1Reference(http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-encounter)encompassingEncounter
... ccda-data-enterer-extension 0..1Reference(Profile daf-core-pract)dataEnterer
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-data-enterer-extension
... ccda-informant-extension 0..*Reference(Profile daf-core-pract)informant
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-informant-extension
... ccda-information-recipient-extension 0..*Reference(Profile daf-core-pract)informationRecipient
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-information-recipient-extension
... ccda-participant-extension 0..*Reference(http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-relatedperson)participant
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-participant-extension
... ccda-performer-extension 0..*Reference(Profile daf-core-pract)performer
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-performer-extension
... ccda-authorization-extension 0..*Reference(http://hl7.org/fhir/ccda/StructureDefinition/ccda-consent)authorization
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-authorization-extension

doco Documentation for this format

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition I0..*A set of resources composed into a single coherent clinical statement with clinical attestation
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 1..1codelanguage
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... ccda-data-enterer-extension I0..1Reference(Profile daf-core-pract)dataEnterer
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-data-enterer-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... ccda-informant-extension I0..*Reference(Profile daf-core-pract)informant
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-informant-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... ccda-information-recipient-extension I0..*Reference(Profile daf-core-pract)informationRecipient
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-information-recipient-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... ccda-participant-extension I0..*Reference(http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-relatedperson)participant
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-participant-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... ccda-performer-extension I0..*Reference(Profile daf-core-pract)performer
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-performer-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... ccda-authorization-extension I0..*Reference(http://hl7.org/fhir/ccda/StructureDefinition/ccda-consent)authorization
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-authorization-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑1..1Identifieridentifier
... date ∑1..1dateTimedate
... type ∑1..1CodeableConceptDocument Type
Binding: FHIR Document Type Codes (preferred)
... class ∑0..1CodeableConceptCategorization of Composition
Binding: FHIR Document Class Codes (example)
... title ∑1..1stringDocument Title
... status ?!∑1..1codestatus
Binding: CompositionStatus (required)
... confidentiality ?!∑1..1codeconfidentiality
Binding: HL7 BasicConfidentialityKind (required)
... subject ∑1..1Reference(Profile daf-core-patient)recordTarget
... author ∑1..*Reference(Profile daf-core-pract | http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-core-device)author
... attester ∑BackboneElementAttests to accuracy of composition
Slice: Unordered, Open, by Composition.attester.mode
... attester ∑0..*BackboneElementlegalAuthenticator
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... mode ∑1..*codemode
Binding: CompositionAttestationMode (required)
Fixed Value: legal
.... time ∑0..1dateTimeWhen composition attested
.... party ∑0..1Reference(Profile daf-core-pract)party
... attester ∑0..*BackboneElementauthenticator
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... mode ∑1..*codemode
Binding: CompositionAttestationMode (required)
.... time ∑0..1dateTimeWhen composition attested
.... party ∑0..1Reference(Profile daf-core-pract)party
... custodian ∑1..1Reference(Profile daf-core-organization)custodian
... event ∑1..*BackboneElementserviceEvent
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... code ∑0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example)
.... period ∑1..1Periodperiod
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... start ∑I1..1dateTimestart
..... end ∑I0..1dateTimeEnd time with inclusive boundary, if not ongoing
.... detail ∑0..*Reference(Resource)The event(s) being documented
... encounter ∑0..1Reference(http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-encounter)encompassingEncounter
... section I0..*BackboneElementComposition is broken into sections
cmp-1: A section must at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: Document Section Codes (example)
.... 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: List Order Codes (preferred)
.... entry I0..*Reference(Resource)A reference to data that supports this section
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition:c-cdaonfhirusrealmheader.section
Nested Section

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

This structure is derived from Composition

Summary

Mandatory: 13 elements (+2 nested mandatory elements)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Composition.attester is sliced based on the value of Composition.attester.mode

Differential View

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*
... language 1..1codelanguage
... identifier 1..1Identifieridentifier
... date 1..1dateTimedate
... type 1..1CodeableConceptDocument Type
... title 1..1stringDocument Title
... status 1..1codestatus
... confidentiality 1..1codeconfidentiality
Binding: HL7 BasicConfidentialityKind (required)
... subject 1..1Reference(Profile daf-core-patient)recordTarget
... author 1..*Reference(Profile daf-core-pract | http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-core-device)author
... attester BackboneElementSlice: Unordered, Open, by Composition.attester.mode
... attester 0..*BackboneElementlegalAuthenticator
.... mode 1..*codemode
Fixed Value: legal
.... party 0..1Reference(Profile daf-core-pract)party
... attester 0..*BackboneElementauthenticator
.... mode 1..*codemode
.... party 0..1Reference(Profile daf-core-pract)party
... custodian 1..1Reference(Profile daf-core-organization)custodian
... event 1..*BackboneElementserviceEvent
.... period 1..1Periodperiod
..... start 1..1dateTimestart
... encounter 0..1Reference(http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-encounter)encompassingEncounter
... ccda-data-enterer-extension 0..1Reference(Profile daf-core-pract)dataEnterer
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-data-enterer-extension
... ccda-informant-extension 0..*Reference(Profile daf-core-pract)informant
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-informant-extension
... ccda-information-recipient-extension 0..*Reference(Profile daf-core-pract)informationRecipient
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-information-recipient-extension
... ccda-participant-extension 0..*Reference(http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-relatedperson)participant
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-participant-extension
... ccda-performer-extension 0..*Reference(Profile daf-core-pract)performer
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-performer-extension
... ccda-authorization-extension 0..*Reference(http://hl7.org/fhir/ccda/StructureDefinition/ccda-consent)authorization
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-authorization-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition I0..*A set of resources composed into a single coherent clinical statement with clinical attestation
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 1..1codelanguage
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... ccda-data-enterer-extension I0..1Reference(Profile daf-core-pract)dataEnterer
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-data-enterer-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... ccda-informant-extension I0..*Reference(Profile daf-core-pract)informant
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-informant-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... ccda-information-recipient-extension I0..*Reference(Profile daf-core-pract)informationRecipient
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-information-recipient-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... ccda-participant-extension I0..*Reference(http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-relatedperson)participant
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-participant-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... ccda-performer-extension I0..*Reference(Profile daf-core-pract)performer
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-performer-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... ccda-authorization-extension I0..*Reference(http://hl7.org/fhir/ccda/StructureDefinition/ccda-consent)authorization
URL: http://hl7.org/fhir/ccda/StructureDefinition/ccda-authorization-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑1..1Identifieridentifier
... date ∑1..1dateTimedate
... type ∑1..1CodeableConceptDocument Type
Binding: FHIR Document Type Codes (preferred)
... class ∑0..1CodeableConceptCategorization of Composition
Binding: FHIR Document Class Codes (example)
... title ∑1..1stringDocument Title
... status ?!∑1..1codestatus
Binding: CompositionStatus (required)
... confidentiality ?!∑1..1codeconfidentiality
Binding: HL7 BasicConfidentialityKind (required)
... subject ∑1..1Reference(Profile daf-core-patient)recordTarget
... author ∑1..*Reference(Profile daf-core-pract | http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-core-device)author
... attester ∑BackboneElementAttests to accuracy of composition
Slice: Unordered, Open, by Composition.attester.mode
... attester ∑0..*BackboneElementlegalAuthenticator
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... mode ∑1..*codemode
Binding: CompositionAttestationMode (required)
Fixed Value: legal
.... time ∑0..1dateTimeWhen composition attested
.... party ∑0..1Reference(Profile daf-core-pract)party
... attester ∑0..*BackboneElementauthenticator
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... mode ∑1..*codemode
Binding: CompositionAttestationMode (required)
.... time ∑0..1dateTimeWhen composition attested
.... party ∑0..1Reference(Profile daf-core-pract)party
... custodian ∑1..1Reference(Profile daf-core-organization)custodian
... event ∑1..*BackboneElementserviceEvent
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... code ∑0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example)
.... period ∑1..1Periodperiod
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... start ∑I1..1dateTimestart
..... end ∑I0..1dateTimeEnd time with inclusive boundary, if not ongoing
.... detail ∑0..*Reference(Resource)The event(s) being documented
... encounter ∑0..1Reference(http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-encounter)encompassingEncounter
... section I0..*BackboneElementComposition is broken into sections
cmp-1: A section must at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: Document Section Codes (example)
.... 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: List Order Codes (preferred)
.... entry I0..*Reference(Resource)A reference to data that supports this section
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition:c-cdaonfhirusrealmheader.section
Nested Section

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Composition.languageCommon LanguagesextensibleCommon Languages
Composition.typeFHIR Document Type CodespreferredFHIR Document Type Codes
Composition.classFHIR Document Class CodesexampleFHIR Document Class Codes
Composition.statusCompositionStatusrequiredCompositionStatus
Composition.confidentialityHL7 BasicConfidentialityKindrequiredHL7 BasicConfidentialityKind
Composition.attester.modeCompositionAttestationModerequiredCompositionAttestationMode
Composition.attester.modeCompositionAttestationModerequiredCompositionAttestationMode
Composition.event.codev3 Code System ActCodeexamplev3 Code System ActCode
Composition.section.codeDocument Section CodesexampleDocument Section Codes
Composition.section.modeListModerequiredListMode
Composition.section.orderedByList Order CodespreferredList Order Codes
Composition.section.emptyReasonList Empty ReasonspreferredList Empty Reasons

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2CompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1CompositionIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4CompositionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3CompositionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
ele-1Composition.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Composition.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Composition.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Composition.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Composition.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Composition.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Composition.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Composition.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Composition.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Composition.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Composition.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Composition.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Composition.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Composition.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
cmp-1Composition.sectionA section must at least one of text, entries, or sub-sections
XPath: exists(f:text) or exists(f:entry) or exists(f:section)
cmp-2Composition.sectionA section can only have an emptyReason if it is empty
XPath: not(exists(f:emptyReason) and exists(f:entry))
.