GDHCN Trust Network - Personal Health Wallet
0.1.0 - ci-build
GDHCN Trust Network - Personal Health Wallet
0.1.0 - ci-build
GDHCN Trust Network - Personal Health Wallet, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-trust-phw/ and changes regularly. See the Directory of published versions
| Official URL: http://smart.who.int/trust-phw/StructureDefinition/DVCComposition | Version: 0.1.0 | |||
| Draft as of 2026-10-23 | Computable Name: DVCComposition | |||
Digital Vaccination Certificate - Composition
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..* | Identifier | Version-independent identifier for the Composition | |
| status |
1..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): The workflow/clinical status of the composition. | |
| type |
1..1 | CodeableConceptIPS | Kind of composition ("DVC") Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: | |
  subject |
1..* | Reference(DVC Patient) | Who and/or what the composition is about | |
  reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| date |
1..1 | dateTime | Composition editing time | |
| author |
1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition | |
| title |
1..1 | string | Human Readable name/title | |
| event |
0..1 | BackboneElement | The clinical service(s) being documented | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
  Slices for section |
C | 2..* | BackboneElement | Composition is broken into sections Slice: Unordered, Closed by value:code, type:focus Constraints: cmp-1, cmp-2 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
   section:All Slices |
Content/Rules for all slices | |||
  modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 entry |
C | 0..* | Reference(Resource) | A reference to data that supports this section |
 section:demographic |
C | 1..1 | BackboneElement | Demographic Status Section Constraints: cmp-1, cmp-2 |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: | |
 entry |
C | 0..* | Reference(DVC Patient) | A reference to data that supports this section |
 section:vaccination |
C | 1..* | BackboneElement | Vaccination Status Section Constraints: cmp-1, cmp-2 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: | |
| entry |
C | 0..* | Reference(DVC Immunization) | A reference to data that supports this section |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.status | Base | required | Composition Status | 📍5.0.0 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:demographic.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:vaccination.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section, Composition.section:demographic, Composition.section:vaccination | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section, Composition.section:demographic, Composition.section:vaccination | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | If 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | 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-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Composition |
Composition | |||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| identifier |
0..* | Identifier | Version-independent identifier for the Composition | |
| status |
1..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown | |
| type |
1..1 | CodeableConceptIPS | Kind of composition ("DVC") Required Pattern: | |
| subject |
1..* | Reference(DVC Patient) | Who and/or what the composition is about | |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| date |
1..1 | dateTime | Composition editing time | |
| event |
0..1 | BackboneElement | The clinical service(s) being documented | |
| period |
||||
| start |
0..1 | dateTime | Starting time with inclusive boundary | |
| end |
0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
| Slices for section |
2..* | BackboneElement | Composition is broken into sections Slice: Unordered, Closed by value:code, type:focus Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| section:demographic |
1..1 | BackboneElement | Demographic Status Section | |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: | |
| entry |
0..* | Reference(DVC Patient) | A reference to data that supports this section | |
| section:vaccination |
1..* | BackboneElement | Vaccination Status Section | |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: | |
| entry |
0..* | Reference(DVC Immunization) | A reference to data that supports this section | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | Composition | 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 |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| url |
0..1 | uri | Canonical identifier for this Composition, represented as a URI (globally unique) | |||||
| identifier |
0..* | Identifier | Version-independent identifier for the Composition | |||||
| version |
0..1 | string | An explicitly assigned identifer of a variation of the content in the Composition | |||||
| status |
1..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): The workflow/clinical status of the composition. | |||||
| type |
1..1 | CodeableConceptIPS | Kind of composition ("DVC") Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: | |||||
| category |
0..* | CodeableConcept | Categorization of Composition Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level. | |||||
| subject |
1..* | Reference(DVC Patient) | Who and/or what the composition is about | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
C | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
C | 0..1 | string | Text alternative for the resource | ||||
| encounter |
0..1 | Reference(Encounter) | Context of the Composition | |||||
| date |
1..1 | dateTime | Composition editing time | |||||
| useContext |
0..* | UsageContext | The context that the content is intended to support | |||||
| author |
1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition | |||||
| name |
0..1 | string | Name for this Composition (computer friendly) | |||||
| title |
1..1 | string | Human Readable name/title | |||||
| note |
0..* | Annotation | For any additional notes | |||||
| attester |
0..* | BackboneElement | Attests to accuracy of composition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition. | |||||
| time |
0..1 | dateTime | When the composition was attested | |||||
| party |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| custodian |
0..1 | Reference(Organization) | Organization which maintains the composition | |||||
| relatesTo |
0..* | RelatedArtifact | Relationships to other compositions/documents | |||||
| event |
0..1 | BackboneElement | The clinical service(s) being documented | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| period |
0..1 | Period | The period covered by the documentation | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| detail |
0..* | CodeableReference(Resource) | The event(s) being documented, as code(s), reference(s), or both Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
| Slices for section |
C | 2..* | BackboneElement | Composition is broken into sections Slice: Unordered, Closed by value:code, type:focus Constraints: cmp-1, cmp-2 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| section:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
0..* | See section (Composition) | Nested Section | |||||
| section:demographic |
C | 1..1 | BackboneElement | Demographic Status Section Constraints: cmp-1, cmp-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
C | 0..* | Reference(DVC Patient) | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
0..* | See section (Composition) | Nested Section | |||||
| section:vaccination |
C | 1..* | BackboneElement | Vaccination Status Section Constraints: cmp-1, cmp-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
C | 0..* | Reference(DVC Immunization) | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
0..* | See section (Composition) | Nested Section | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Composition.status | Base | required | Composition Status | 📍5.0.0 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍5.0.0 | FHIR Std. |
| Composition.category | Base | example | Referenced Item Category Value Set | 📍5.0.0 | FHIR Std. |
| Composition.subject.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| Composition.attester.mode | Base | preferred | Composition Attestation Mode | 📍5.0.0 | FHIR Std. |
| Composition.event.detail | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.3 |
| Composition.section.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Composition.section:demographic.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:demographic.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:demographic.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Composition.section:vaccination.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:vaccination.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:vaccination.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section, Composition.section:demographic, Composition.section:vaccination | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section, Composition.section:demographic, Composition.section:vaccination | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | If 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | 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-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Composition
Summary
Mandatory: 6 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..* | Identifier | Version-independent identifier for the Composition | |
| status |
1..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): The workflow/clinical status of the composition. | |
| type |
1..1 | CodeableConceptIPS | Kind of composition ("DVC") Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: | |
| subject |
1..* | Reference(DVC Patient) | Who and/or what the composition is about | |
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| date |
1..1 | dateTime | Composition editing time | |
| author |
1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition | |
| title |
1..1 | string | Human Readable name/title | |
| event |
0..1 | BackboneElement | The clinical service(s) being documented | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| Slices for section |
C | 2..* | BackboneElement | Composition is broken into sections Slice: Unordered, Closed by value:code, type:focus Constraints: cmp-1, cmp-2 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
| section:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| entry |
C | 0..* | Reference(Resource) | A reference to data that supports this section |
| section:demographic |
C | 1..1 | BackboneElement | Demographic Status Section Constraints: cmp-1, cmp-2 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: | |
| entry |
C | 0..* | Reference(DVC Patient) | A reference to data that supports this section |
| section:vaccination |
C | 1..* | BackboneElement | Vaccination Status Section Constraints: cmp-1, cmp-2 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: | |
| entry |
C | 0..* | Reference(DVC Immunization) | A reference to data that supports this section |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.status | Base | required | Composition Status | 📍5.0.0 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:demographic.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:vaccination.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section, Composition.section:demographic, Composition.section:vaccination | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section, Composition.section:demographic, Composition.section:vaccination | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | If 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | 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-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Composition |
Composition | |||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| identifier |
0..* | Identifier | Version-independent identifier for the Composition | |
| status |
1..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown | |
| type |
1..1 | CodeableConceptIPS | Kind of composition ("DVC") Required Pattern: | |
| subject |
1..* | Reference(DVC Patient) | Who and/or what the composition is about | |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| date |
1..1 | dateTime | Composition editing time | |
| event |
0..1 | BackboneElement | The clinical service(s) being documented | |
| period |
||||
| start |
0..1 | dateTime | Starting time with inclusive boundary | |
| end |
0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
| Slices for section |
2..* | BackboneElement | Composition is broken into sections Slice: Unordered, Closed by value:code, type:focus Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| section:demographic |
1..1 | BackboneElement | Demographic Status Section | |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: | |
| entry |
0..* | Reference(DVC Patient) | A reference to data that supports this section | |
| section:vaccination |
1..* | BackboneElement | Vaccination Status Section | |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: | |
| entry |
0..* | Reference(DVC Immunization) | A reference to data that supports this section | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | Composition | 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 |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| url |
0..1 | uri | Canonical identifier for this Composition, represented as a URI (globally unique) | |||||
| identifier |
0..* | Identifier | Version-independent identifier for the Composition | |||||
| version |
0..1 | string | An explicitly assigned identifer of a variation of the content in the Composition | |||||
| status |
1..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): The workflow/clinical status of the composition. | |||||
| type |
1..1 | CodeableConceptIPS | Kind of composition ("DVC") Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: | |||||
| category |
0..* | CodeableConcept | Categorization of Composition Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level. | |||||
| subject |
1..* | Reference(DVC Patient) | Who and/or what the composition is about | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
C | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
C | 0..1 | string | Text alternative for the resource | ||||
| encounter |
0..1 | Reference(Encounter) | Context of the Composition | |||||
| date |
1..1 | dateTime | Composition editing time | |||||
| useContext |
0..* | UsageContext | The context that the content is intended to support | |||||
| author |
1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition | |||||
| name |
0..1 | string | Name for this Composition (computer friendly) | |||||
| title |
1..1 | string | Human Readable name/title | |||||
| note |
0..* | Annotation | For any additional notes | |||||
| attester |
0..* | BackboneElement | Attests to accuracy of composition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition. | |||||
| time |
0..1 | dateTime | When the composition was attested | |||||
| party |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| custodian |
0..1 | Reference(Organization) | Organization which maintains the composition | |||||
| relatesTo |
0..* | RelatedArtifact | Relationships to other compositions/documents | |||||
| event |
0..1 | BackboneElement | The clinical service(s) being documented | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| period |
0..1 | Period | The period covered by the documentation | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| detail |
0..* | CodeableReference(Resource) | The event(s) being documented, as code(s), reference(s), or both Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
| Slices for section |
C | 2..* | BackboneElement | Composition is broken into sections Slice: Unordered, Closed by value:code, type:focus Constraints: cmp-1, cmp-2 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| section:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
0..* | See section (Composition) | Nested Section | |||||
| section:demographic |
C | 1..1 | BackboneElement | Demographic Status Section Constraints: cmp-1, cmp-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
C | 0..* | Reference(DVC Patient) | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
0..* | See section (Composition) | Nested Section | |||||
| section:vaccination |
C | 1..* | BackboneElement | Vaccination Status Section Constraints: cmp-1, cmp-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
C | 0..* | Reference(DVC Immunization) | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
0..* | See section (Composition) | Nested Section | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Composition.status | Base | required | Composition Status | 📍5.0.0 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍5.0.0 | FHIR Std. |
| Composition.category | Base | example | Referenced Item Category Value Set | 📍5.0.0 | FHIR Std. |
| Composition.subject.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| Composition.attester.mode | Base | preferred | Composition Attestation Mode | 📍5.0.0 | FHIR Std. |
| Composition.event.detail | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.3 |
| Composition.section.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Composition.section:demographic.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:demographic.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:demographic.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Composition.section:vaccination.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:vaccination.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:vaccination.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section, Composition.section:demographic, Composition.section:vaccination | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section, Composition.section:demographic, Composition.section:vaccination | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | If 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | 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-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Composition
Summary
Mandatory: 6 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron