STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

M.?? StructureDefinition: C-CDA on FHIR US Realm Header

The official URL for this profile is: 

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

This profile was published on [no date] with unknown status '" by .

M.??.1 Formal Views of Profile Content

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

This structure is derived from Composition.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*DomainResource
... 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(DAF-Patient)recordTarget
... author 1..*Reference(DAF-Pract)author
... attester BackboneElementSlice: Unordered, Open, by Composition.attester.mode
... attester 0..1BackboneElementlegalAuthenticator
.... mode 1..1codemode
Fixed Value: legal
.... party 0..1Reference(DAF-Pract)party
... attester 0..*BackboneElementauthenticator
.... mode 1..*codemode
... custodian 1..1Reference(DAF-Organization)custodian
... event 1..1BackboneElementserviceEvent
.... period 1..1Periodperiod
..... start 1..1dateTimestart
... encounter 0..1Reference(DAF-Encounter)encompassingEncounter
... section 1..*BackboneElementsection
... ccda-data-enterer-extension 0..1Reference(Reference)dataEnterer
URL: http://hl7.org/fhir/StructureDefinition/ccda-data-enterer-extension
... ccda-informant-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metainformant
URL: http://hl7.org/fhir/StructureDefinition/ccda-informant-extension
... ccda-information-recipient-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), MetainformationRecipient
URL: http://hl7.org/fhir/StructureDefinition/ccda-information-recipient-extension
... ccda-participant-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metaparticipant
URL: http://hl7.org/fhir/StructureDefinition/ccda-participant-extension
... ccda-performer-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metaperformer
URL: http://hl7.org/fhir/StructureDefinition/ccda-performer-extension
... ccda-authorization-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metaperformer
URL: http://hl7.org/fhir/StructureDefinition/ccda-authorization-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*DomainResourceA set of resources composed into a single coherent clinical statement with clinical attestation
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 1..1codelanguage
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... ccda-data-enterer-extension 0..1Reference(Reference)dataEnterer
URL: http://hl7.org/fhir/StructureDefinition/ccda-data-enterer-extension
... ccda-informant-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metainformant
URL: http://hl7.org/fhir/StructureDefinition/ccda-informant-extension
... ccda-information-recipient-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), MetainformationRecipient
URL: http://hl7.org/fhir/StructureDefinition/ccda-information-recipient-extension
... ccda-participant-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metaparticipant
URL: http://hl7.org/fhir/StructureDefinition/ccda-participant-extension
... ccda-performer-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metaperformer
URL: http://hl7.org/fhir/StructureDefinition/ccda-performer-extension
... ccda-authorization-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metaperformer
URL: http://hl7.org/fhir/StructureDefinition/ccda-authorization-extension
... 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(DAF-Patient)recordTarget
... author ∑1..*Reference(DAF-Pract)author
... attester ∑BackboneElementAttests to accuracy of composition
Slice: Unordered, Open, by Composition.attester.mode
... attester ∑0..1BackboneElementlegalAuthenticator
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... mode ∑1..1codemode
Binding: CompositionAttestationMode (required)
Fixed Value: legal
.... time ∑0..1dateTimeWhen composition attested
.... party ∑0..1Reference(DAF-Pract)party
... attester ∑0..*BackboneElementauthenticator
.... 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(Patient | Practitioner | Organization)Who attested the composition
... custodian ∑1..1Reference(DAF-Organization)custodian
... event ∑1..1BackboneElementserviceEvent
.... 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
..... 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(DAF-Encounter)encompassingEncounter
... section I1..*BackboneElementsection
cmp-2: A section can only have an emptyReason if it is empty
cmp-1: A section must at least one of text, entries, or sub-sections
.... 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 #section
Nested Section

doco Documentation for this format

todo

Differential View

This structure is derived from Composition.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*DomainResource
... 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(DAF-Patient)recordTarget
... author 1..*Reference(DAF-Pract)author
... attester BackboneElementSlice: Unordered, Open, by Composition.attester.mode
... attester 0..1BackboneElementlegalAuthenticator
.... mode 1..1codemode
Fixed Value: legal
.... party 0..1Reference(DAF-Pract)party
... attester 0..*BackboneElementauthenticator
.... mode 1..*codemode
... custodian 1..1Reference(DAF-Organization)custodian
... event 1..1BackboneElementserviceEvent
.... period 1..1Periodperiod
..... start 1..1dateTimestart
... encounter 0..1Reference(DAF-Encounter)encompassingEncounter
... section 1..*BackboneElementsection
... ccda-data-enterer-extension 0..1Reference(Reference)dataEnterer
URL: http://hl7.org/fhir/StructureDefinition/ccda-data-enterer-extension
... ccda-informant-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metainformant
URL: http://hl7.org/fhir/StructureDefinition/ccda-informant-extension
... ccda-information-recipient-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), MetainformationRecipient
URL: http://hl7.org/fhir/StructureDefinition/ccda-information-recipient-extension
... ccda-participant-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metaparticipant
URL: http://hl7.org/fhir/StructureDefinition/ccda-participant-extension
... ccda-performer-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metaperformer
URL: http://hl7.org/fhir/StructureDefinition/ccda-performer-extension
... ccda-authorization-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metaperformer
URL: http://hl7.org/fhir/StructureDefinition/ccda-authorization-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*DomainResourceA set of resources composed into a single coherent clinical statement with clinical attestation
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 1..1codelanguage
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... ccda-data-enterer-extension 0..1Reference(Reference)dataEnterer
URL: http://hl7.org/fhir/StructureDefinition/ccda-data-enterer-extension
... ccda-informant-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metainformant
URL: http://hl7.org/fhir/StructureDefinition/ccda-informant-extension
... ccda-information-recipient-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), MetainformationRecipient
URL: http://hl7.org/fhir/StructureDefinition/ccda-information-recipient-extension
... ccda-participant-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metaparticipant
URL: http://hl7.org/fhir/StructureDefinition/ccda-participant-extension
... ccda-performer-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metaperformer
URL: http://hl7.org/fhir/StructureDefinition/ccda-performer-extension
... ccda-authorization-extension 0..*boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(Reference), Metaperformer
URL: http://hl7.org/fhir/StructureDefinition/ccda-authorization-extension
... 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(DAF-Patient)recordTarget
... author ∑1..*Reference(DAF-Pract)author
... attester ∑BackboneElementAttests to accuracy of composition
Slice: Unordered, Open, by Composition.attester.mode
... attester ∑0..1BackboneElementlegalAuthenticator
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... mode ∑1..1codemode
Binding: CompositionAttestationMode (required)
Fixed Value: legal
.... time ∑0..1dateTimeWhen composition attested
.... party ∑0..1Reference(DAF-Pract)party
... attester ∑0..*BackboneElementauthenticator
.... 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(Patient | Practitioner | Organization)Who attested the composition
... custodian ∑1..1Reference(DAF-Organization)custodian
... event ∑1..1BackboneElementserviceEvent
.... 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
..... 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(DAF-Encounter)encompassingEncounter
... section I1..*BackboneElementsection
cmp-2: A section can only have an emptyReason if it is empty
cmp-1: A section must at least one of text, entries, or sub-sections
.... 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 #section
Nested Section

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

M.??.2 Terminology Bindings

PathNameConformanceValueSet
Composition.language?extrequiredhttp://tools.ietf.org/html/bcp47
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

M.??.3 Constraints

IdPathDetailsRequirements
cmp-2Composition.sectionA section can only have an emptyReason if it is empty
XPath: not(exists(f:emptyReason) and exists(f:entry))
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)
.