GDHCN Trust Network - Personal Health Wallet
0.1.0 - release International flag

This page is part of the GDHCN Trust Network - Personal Health Wallet (v0.1.0: Releases Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: Digital Vaccination Certificate - Composition

Official URL: http://smart.who.int/trust-phw/StructureDefinition/DVCSDComposition Version: 0.1.0
Draft as of 2025-10-07 Computable Name: DVCSDComposition

Digital Vaccination Certificate - Composition

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* DVCComposition 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 S 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
.... Slices for extension Content/Rules for all slices
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... identifier SΣ 0..1 Identifier Version-independent identifier for the Composition
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type SΣ 1..1 CodeableConceptIPS Kind of composition ("DVC")
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82593-5
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(DVC Patient) Who and/or what the composition is about
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... date SΣ 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
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... section:demographic SC 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 45970-1
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... entry C 0..* Reference(DVC Patient with Selective Disclosure) A reference to data that supports this section
.... section:vaccination SC 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11369-6
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... entry C 0..* Reference(DVC Immunization with Selective Disclosure) A reference to data that supports this section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.text.status Base required NarrativeStatus 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.section:demographic.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:vaccination.​code Base example Document Section Codes 📍4.0.1 FHIR Std.

Constraints

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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
txt-1 error Composition.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Composition.text.div The narrative SHALL have some non-whitespace content htmlChecks()

This structure is derived from DVCComposition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition DVCComposition
... text
.... Slices for extension Content/Rules for all slices
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... Slices for section Content/Rules for all slices
.... section:demographic 1..1 BackboneElement Demographic Status Section
..... entry 0..* Reference(DVC Patient with Selective Disclosure) A reference to data that supports this section
.... section:vaccination 1..* BackboneElement Vaccination Status Section
..... entry 0..* Reference(DVC Immunization with Selective Disclosure) A reference to data that supports this section

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* DVCComposition 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
... text S 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
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..1 Identifier Version-independent identifier for the Composition
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type SΣ 1..1 CodeableConceptIPS Kind of composition ("DVC")
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82593-5
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... category Σ 0..* CodeableConcept Categorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject SΣ 1..1 Reference(DVC Patient) Who and/or what the composition is about
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date SΣ 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
... confidentiality Σ 0..1 code As defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.
... 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 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): 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..* BackboneElement Relationships to other compositions/documents
.... 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
.... code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target[x] 1..1 Target of the relationship
..... targetIdentifier Identifier
..... targetReference Reference(Composition)
... 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
.... code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period The period covered by the documentation
..... id 0..1 string 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..* Reference(Resource) The event(s) 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
.... 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
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... 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 C 0..* See section (Composition) Nested Section
.... section:demographic SC 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 45970-1
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... 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 with Selective Disclosure) 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 C 0..* See section (Composition) Nested Section
.... section:vaccination SC 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11369-6
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... 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 with Selective Disclosure) 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 C 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.text.status Base required NarrativeStatus 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
Composition.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.event.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
Composition.section.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:demographic.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:demographic.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:demographic.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:demographic.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:vaccination.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:vaccination.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:vaccination.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:vaccination.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
txt-1 error Composition.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Composition.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* DVCComposition 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 S 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
.... Slices for extension Content/Rules for all slices
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... identifier SΣ 0..1 Identifier Version-independent identifier for the Composition
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type SΣ 1..1 CodeableConceptIPS Kind of composition ("DVC")
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82593-5
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(DVC Patient) Who and/or what the composition is about
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... date SΣ 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
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... section:demographic SC 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 45970-1
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... entry C 0..* Reference(DVC Patient with Selective Disclosure) A reference to data that supports this section
.... section:vaccination SC 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11369-6
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... entry C 0..* Reference(DVC Immunization with Selective Disclosure) A reference to data that supports this section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.text.status Base required NarrativeStatus 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.section:demographic.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:vaccination.​code Base example Document Section Codes 📍4.0.1 FHIR Std.

Constraints

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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
txt-1 error Composition.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Composition.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Differential View

This structure is derived from DVCComposition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition DVCComposition
... text
.... Slices for extension Content/Rules for all slices
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... Slices for section Content/Rules for all slices
.... section:demographic 1..1 BackboneElement Demographic Status Section
..... entry 0..* Reference(DVC Patient with Selective Disclosure) A reference to data that supports this section
.... section:vaccination 1..* BackboneElement Vaccination Status Section
..... entry 0..* Reference(DVC Immunization with Selective Disclosure) A reference to data that supports this section

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* DVCComposition 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
... text S 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
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..1 Identifier Version-independent identifier for the Composition
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type SΣ 1..1 CodeableConceptIPS Kind of composition ("DVC")
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82593-5
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... category Σ 0..* CodeableConcept Categorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject SΣ 1..1 Reference(DVC Patient) Who and/or what the composition is about
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date SΣ 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
... confidentiality Σ 0..1 code As defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.
... 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 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): 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..* BackboneElement Relationships to other compositions/documents
.... 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
.... code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target[x] 1..1 Target of the relationship
..... targetIdentifier Identifier
..... targetReference Reference(Composition)
... 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
.... code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period The period covered by the documentation
..... id 0..1 string 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..* Reference(Resource) The event(s) 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
.... 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
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... 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 C 0..* See section (Composition) Nested Section
.... section:demographic SC 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 45970-1
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... 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 with Selective Disclosure) 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 C 0..* See section (Composition) Nested Section
.... section:vaccination SC 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11369-6
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... 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 with Selective Disclosure) 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 C 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.text.status Base required NarrativeStatus 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
Composition.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.event.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
Composition.section.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:demographic.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:demographic.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:demographic.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:demographic.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:vaccination.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:vaccination.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:vaccination.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:vaccination.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
txt-1 error Composition.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Composition.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron