This page is part of the C-CDA on FHIR Implementation Guide (v1.0.0: STU 1) based on FHIR R3. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-US-Realm-Header
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 builds on Clinical Document Profile for Composition.
This profile was published on Sat Apr 07 06:53:01 AEST 2018 as a draft by null.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Clinical Document Profile for Composition
Summary
Mandatory: 4 elements (3 nested mandatory elements)
Fixed Value: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Clinical Document Profile for Composition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | 0..* | |||
language | 1..1 | code | language | |
CCDA-on-FHIR-Data-Enterer | 0..1 | Reference(US Core Practitioner Profile) | Extension URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Data-Enterer | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Data-Enterer" | |
CCDA-on-FHIR-Informant | 0..* | Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson) | informant URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Informant | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Informant" | |
CCDA-on-FHIR-Information-Recipient | 0..* | Reference(US Core Practitioner Profile) | informationRecipient URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Information-Recipient | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Information-Recipient" | |
CCDA-on-FHIR-Participant | 0..* | Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson) | participant URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Participant | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Participant" | |
CCDA-on-FHIR-Performer | 0..* | Reference(US Core Practitioner Profile) | performer URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Performer | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Performer" | |
CCDA-on-FHIR-Authorization | 0..* | Reference(C-CDA on FHIR Consent) | authorization URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Authorization | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Authorization" | |
CCDA-on-FHIR-In-Fulfillment-Of-Order | 0..* | Reference(ProcedureRequest) | authorization URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-In-Fulfillment-Of-Order | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-In-Fulfillment-Of-Order" | |
identifier | 1..1 | Identifier | identifier | |
subject | 1..1 | Reference(US Core Patient Profile | Group) | ||
date | 1..1 | dateTime | date | |
author | 1..* | Reference(US Core Practitioner Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson) | ||
title | 1..1 | string | Document Title | |
confidentiality | 1..1 | code | confidentiality | |
attester | BackboneElement | Slice: Unordered, Open by value:mode | ||
attester | 0..1 | BackboneElement | attester | |
mode | 1..1 | code | mode Fixed Value: legal | |
party | 1..1 | Reference(US Core Practitioner Profile) | party | |
attester | 0..* | BackboneElement | attester | |
mode | 1..* | code | mode Fixed Value: professional | |
party | 1..1 | Reference(US Core Practitioner Profile) | party | |
attester | 0..* | BackboneElement | attester | |
mode | 1..* | code | mode Fixed Value: personal | |
party | 1..1 | Reference(US Core Patient Profile) | party | |
custodian | 1..1 | Reference(US Core Organization Profile) | custodian | |
Documentation for this format |
This structure is derived from Clinical Document Profile for Composition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | I | 0..* | A set of resources composed into a single coherent clinical statement with clinical attestation | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 1..1 | code | language Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
CCDA-on-FHIR-Data-Enterer | I | 0..1 | Reference(US Core Practitioner Profile) | Extension URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Data-Enterer |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Data-Enterer" | |
valueReference | 0..1 | Reference(US Core Practitioner Profile) | Value of extension | |
CCDA-on-FHIR-Informant | I | 0..* | Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson) | informant URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Informant |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Informant" | |
valueReference | 0..1 | Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson) | Value of extension | |
CCDA-on-FHIR-Information-Recipient | I | 0..* | Reference(US Core Practitioner Profile) | informationRecipient URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Information-Recipient |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Information-Recipient" | |
valueReference | 0..1 | Reference(US Core Practitioner Profile) | Value of extension | |
CCDA-on-FHIR-Participant | I | 0..* | Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson) | participant URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Participant |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Participant" | |
valueReference | 0..1 | Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson) | Value of extension | |
CCDA-on-FHIR-Performer | I | 0..* | Reference(US Core Practitioner Profile) | performer URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Performer |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Performer" | |
valueReference | 0..1 | Reference(US Core Practitioner Profile) | Value of extension | |
CCDA-on-FHIR-Authorization | I | 0..* | Reference(C-CDA on FHIR Consent) | authorization URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Authorization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Authorization" | |
valueReference | 0..1 | Reference(C-CDA on FHIR Consent) | Value of extension | |
CCDA-on-FHIR-In-Fulfillment-Of-Order | I | 0..* | Reference(ProcedureRequest) | authorization URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-In-Fulfillment-Of-Order |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-In-Fulfillment-Of-Order" | |
valueReference | 0..1 | Reference(ProcedureRequest) | Value of extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..1 | Identifier | identifier |
status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required) |
type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred) |
class | Σ | 0..1 | CodeableConcept | Categorization of Composition Binding: FHIR Document Class Codes (example) |
subject | Σ | 1..1 | Reference(US Core Patient Profile | Group) | Who and/or what the composition is about |
encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition |
date | Σ | 1..1 | dateTime | date |
author | Σ | 1..* | Reference(US Core Practitioner Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson) | Who and/or what authored the composition |
title | Σ | 1..1 | string | Document Title |
confidentiality | ?!Σ | 1..1 | code | confidentiality Binding: ConfidentialityClassification (required) |
attester | ΣI | BackboneElement | Attests to accuracy of composition Slice: Unordered, Open by value:mode | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
mode | Σ | 1..* | code | personal | professional | legal | official Binding: CompositionAttestationMode (required) |
time | Σ | 0..1 | dateTime | When the composition was attested |
party | Σ | 0..1 | Reference(Patient | Practitioner | Organization) | Who attested the composition |
attester | ΣI | 0..1 | BackboneElement | attester |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
mode | Σ | 1..1 | code | mode Binding: CompositionAttestationMode (required) Fixed Value: legal |
time | Σ | 0..1 | dateTime | When the composition was attested |
party | Σ | 1..1 | Reference(US Core Practitioner Profile) | party |
attester | ΣI | 0..* | BackboneElement | attester |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
mode | Σ | 1..* | code | mode Binding: CompositionAttestationMode (required) Fixed Value: professional |
time | Σ | 0..1 | dateTime | When the composition was attested |
party | Σ | 1..1 | Reference(US Core Practitioner Profile) | party |
attester | ΣI | 0..* | BackboneElement | attester |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
mode | Σ | 1..* | code | mode Binding: CompositionAttestationMode (required) Fixed Value: personal |
time | Σ | 0..1 | dateTime | When the composition was attested |
party | Σ | 1..1 | Reference(US Core Patient Profile) | party |
custodian | Σ | 1..1 | Reference(US Core Organization Profile) | custodian |
relatesTo | ΣI | 0..* | BackboneElement | Relationships to other compositions/documents |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
target[x] | Σ | 1..1 | Identifier, Reference(Composition) | Target of the relationship |
event | ΣI | 0..* | BackboneElement | The clinical service(s) being documented |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example) |
period | Σ | 0..1 | Period | The period covered by the documentation |
detail | Σ | 0..* | Reference(Resource) | The event(s) being documented |
section | I | 0..* | BackboneElement | Composition 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..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
title | 0..1 | string | Label for section (e.g. for ToC) | |
code | 0..1 | CodeableConcept | Classification of section (recommended) Binding: Document Section Codes (example) | |
text | I | 0..1 | Narrative | Text summary of the section, for human interpretation |
mode | ?!Σ | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: List Order Codes (preferred) | |
entry | I | 0..* | Reference(Resource) | A reference to data that supports this section |
emptyReason | I | 0..1 | CodeableConcept | Why the section is empty Binding: List Empty Reasons (preferred) |
section | I | 0..* | Unknown reference to #Composition.section Nested Section | |
Documentation for this format |
This structure is derived from Clinical Document Profile for Composition
Summary
Mandatory: 4 elements (3 nested mandatory elements)
Fixed Value: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Clinical Document Profile for Composition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | 0..* | |||
language | 1..1 | code | language | |
CCDA-on-FHIR-Data-Enterer | 0..1 | Reference(US Core Practitioner Profile) | Extension URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Data-Enterer | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Data-Enterer" | |
CCDA-on-FHIR-Informant | 0..* | Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson) | informant URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Informant | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Informant" | |
CCDA-on-FHIR-Information-Recipient | 0..* | Reference(US Core Practitioner Profile) | informationRecipient URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Information-Recipient | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Information-Recipient" | |
CCDA-on-FHIR-Participant | 0..* | Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson) | participant URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Participant | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Participant" | |
CCDA-on-FHIR-Performer | 0..* | Reference(US Core Practitioner Profile) | performer URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Performer | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Performer" | |
CCDA-on-FHIR-Authorization | 0..* | Reference(C-CDA on FHIR Consent) | authorization URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Authorization | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Authorization" | |
CCDA-on-FHIR-In-Fulfillment-Of-Order | 0..* | Reference(ProcedureRequest) | authorization URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-In-Fulfillment-Of-Order | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-In-Fulfillment-Of-Order" | |
identifier | 1..1 | Identifier | identifier | |
subject | 1..1 | Reference(US Core Patient Profile | Group) | ||
date | 1..1 | dateTime | date | |
author | 1..* | Reference(US Core Practitioner Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson) | ||
title | 1..1 | string | Document Title | |
confidentiality | 1..1 | code | confidentiality | |
attester | BackboneElement | Slice: Unordered, Open by value:mode | ||
attester | 0..1 | BackboneElement | attester | |
mode | 1..1 | code | mode Fixed Value: legal | |
party | 1..1 | Reference(US Core Practitioner Profile) | party | |
attester | 0..* | BackboneElement | attester | |
mode | 1..* | code | mode Fixed Value: professional | |
party | 1..1 | Reference(US Core Practitioner Profile) | party | |
attester | 0..* | BackboneElement | attester | |
mode | 1..* | code | mode Fixed Value: personal | |
party | 1..1 | Reference(US Core Patient Profile) | party | |
custodian | 1..1 | Reference(US Core Organization Profile) | custodian | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | I | 0..* | A set of resources composed into a single coherent clinical statement with clinical attestation | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 1..1 | code | language Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
CCDA-on-FHIR-Data-Enterer | I | 0..1 | Reference(US Core Practitioner Profile) | Extension URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Data-Enterer |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Data-Enterer" | |
valueReference | 0..1 | Reference(US Core Practitioner Profile) | Value of extension | |
CCDA-on-FHIR-Informant | I | 0..* | Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson) | informant URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Informant |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Informant" | |
valueReference | 0..1 | Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson) | Value of extension | |
CCDA-on-FHIR-Information-Recipient | I | 0..* | Reference(US Core Practitioner Profile) | informationRecipient URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Information-Recipient |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Information-Recipient" | |
valueReference | 0..1 | Reference(US Core Practitioner Profile) | Value of extension | |
CCDA-on-FHIR-Participant | I | 0..* | Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson) | participant URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Participant |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Participant" | |
valueReference | 0..1 | Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson) | Value of extension | |
CCDA-on-FHIR-Performer | I | 0..* | Reference(US Core Practitioner Profile) | performer URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Performer |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Performer" | |
valueReference | 0..1 | Reference(US Core Practitioner Profile) | Value of extension | |
CCDA-on-FHIR-Authorization | I | 0..* | Reference(C-CDA on FHIR Consent) | authorization URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Authorization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Authorization" | |
valueReference | 0..1 | Reference(C-CDA on FHIR Consent) | Value of extension | |
CCDA-on-FHIR-In-Fulfillment-Of-Order | I | 0..* | Reference(ProcedureRequest) | authorization URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-In-Fulfillment-Of-Order |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-In-Fulfillment-Of-Order" | |
valueReference | 0..1 | Reference(ProcedureRequest) | Value of extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..1 | Identifier | identifier |
status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required) |
type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred) |
class | Σ | 0..1 | CodeableConcept | Categorization of Composition Binding: FHIR Document Class Codes (example) |
subject | Σ | 1..1 | Reference(US Core Patient Profile | Group) | Who and/or what the composition is about |
encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition |
date | Σ | 1..1 | dateTime | date |
author | Σ | 1..* | Reference(US Core Practitioner Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson) | Who and/or what authored the composition |
title | Σ | 1..1 | string | Document Title |
confidentiality | ?!Σ | 1..1 | code | confidentiality Binding: ConfidentialityClassification (required) |
attester | ΣI | BackboneElement | Attests to accuracy of composition Slice: Unordered, Open by value:mode | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
mode | Σ | 1..* | code | personal | professional | legal | official Binding: CompositionAttestationMode (required) |
time | Σ | 0..1 | dateTime | When the composition was attested |
party | Σ | 0..1 | Reference(Patient | Practitioner | Organization) | Who attested the composition |
attester | ΣI | 0..1 | BackboneElement | attester |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
mode | Σ | 1..1 | code | mode Binding: CompositionAttestationMode (required) Fixed Value: legal |
time | Σ | 0..1 | dateTime | When the composition was attested |
party | Σ | 1..1 | Reference(US Core Practitioner Profile) | party |
attester | ΣI | 0..* | BackboneElement | attester |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
mode | Σ | 1..* | code | mode Binding: CompositionAttestationMode (required) Fixed Value: professional |
time | Σ | 0..1 | dateTime | When the composition was attested |
party | Σ | 1..1 | Reference(US Core Practitioner Profile) | party |
attester | ΣI | 0..* | BackboneElement | attester |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
mode | Σ | 1..* | code | mode Binding: CompositionAttestationMode (required) Fixed Value: personal |
time | Σ | 0..1 | dateTime | When the composition was attested |
party | Σ | 1..1 | Reference(US Core Patient Profile) | party |
custodian | Σ | 1..1 | Reference(US Core Organization Profile) | custodian |
relatesTo | ΣI | 0..* | BackboneElement | Relationships to other compositions/documents |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
target[x] | Σ | 1..1 | Identifier, Reference(Composition) | Target of the relationship |
event | ΣI | 0..* | BackboneElement | The clinical service(s) being documented |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example) |
period | Σ | 0..1 | Period | The period covered by the documentation |
detail | Σ | 0..* | Reference(Resource) | The event(s) being documented |
section | I | 0..* | BackboneElement | Composition 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..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
title | 0..1 | string | Label for section (e.g. for ToC) | |
code | 0..1 | CodeableConcept | Classification of section (recommended) Binding: Document Section Codes (example) | |
text | I | 0..1 | Narrative | Text summary of the section, for human interpretation |
mode | ?!Σ | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: List Order Codes (preferred) | |
entry | I | 0..* | Reference(Resource) | A reference to data that supports this section |
emptyReason | I | 0..1 | CodeableConcept | Why the section is empty Binding: List Empty Reasons (preferred) |
section | I | 0..* | Unknown reference to #Composition.section Nested Section | |
Documentation for this format |
Path | Name | Conformance | ValueSet |
Composition.language | Common Languages | extensible | Common Languages |
Composition.status | CompositionStatus | required | CompositionStatus |
Composition.type | FHIR Document Type Codes | preferred | FHIR Document Type Codes |
Composition.class | FHIR Document Class Codes | example | FHIR Document Class Codes |
Composition.confidentiality | ConfidentialityClassification | required | ConfidentialityClassification |
Composition.attester.mode | CompositionAttestationMode | required | CompositionAttestationMode |
Composition.attester.mode | CompositionAttestationMode | required | CompositionAttestationMode |
Composition.attester.mode | CompositionAttestationMode | required | CompositionAttestationMode |
Composition.attester.mode | CompositionAttestationMode | required | CompositionAttestationMode |
Composition.relatesTo.code | DocumentRelationshipType | required | DocumentRelationshipType |
Composition.event.code | v3 Code System ActCode | example | v3 Code System ActCode |
Composition.section.code | Document Section Codes | example | Document Section Codes |
Composition.section.mode | ListMode | required | ListMode |
Composition.section.orderedBy | List Order Codes | preferred | List Order Codes |
Composition.section.emptyReason | List Empty Reasons | preferred | List Empty Reasons |
Id | Path | Details | Requirements |
dom-2 | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | Composition | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | Composition | If 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-3 | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
ele-1 | Composition.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Composition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Composition.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Composition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Composition.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Composition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Composition.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Composition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Composition.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Composition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Composition.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Composition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Composition.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Composition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Composition.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Composition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Composition.attester | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Composition.attester | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Composition.attester | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Composition.attester | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Composition.relatesTo | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Composition.event | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Composition.section | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
cmp-1 | Composition.section | A section must at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
cmp-2 | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() |