SMART ICVP, 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-icvp/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Digital Vaccination Certificate - Composition

Digital Vaccination Certificate - Composition

Usage:

• Use this Resource Profile: Digital Vaccination Certificate - Bundle

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Composition

Name	Flags	Card.	Type	Description & Constraints
Composition			Composition
text	S	0..1	Narrative	Text summary of the resource, for human interpretation
identifier	S	0..1	Identifier	Version-independent identifier for the Composition
status	S	1..1	code	preliminary | final | amended | entered-in-error
type	S	1..1	CodeableConceptIPS	Kind of composition ("DVC") Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 82593-5
subject	S	1..1	Reference(DVC Patient)	Who and/or what the composition is about
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
date	S	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		1..*	BackboneElement	Composition is broken into sections Slice: Unordered, Closed by value:code, type:focus
section:vaccination	S	1..1	BackboneElement	Vaccination Status Section
code		1..1	CodeableConcept	Classification of section (recommended) Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 11369-6
focus	S	1..1	Reference(DVC Immunization)	Who/what the section is about, when it is not about the subject of composition
entry		0..*	Reference(DVC Immunization)	A reference to data that supports this section
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
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	S	0..1	Narrative	Text summary of the resource, for human interpretation
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
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 82593-5
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	1..*	BackboneElement	Composition is broken into sections Slice: Unordered, Closed by value:code, type:focus cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
section:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
section:vaccination	SC	1..1	BackboneElement	Vaccination Status Section cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
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
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 11369-6
focus	S	1..1	Reference(DVC Immunization)	Who/what the section is about, when it is not about the subject of composition
entry	C	0..*	Reference(DVC Immunization)	A reference to data that supports this section
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Composition.status	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard
Composition.type	preferred	Pattern: LOINC Code 82593-5 http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard
Composition.section:vaccination.code	example	Pattern: LOINC Code 11369-6 http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cmp-1	error	Composition.section, 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: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()

Name	Flags	Card.	Type	Description & Constraints
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text	S	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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	1..*	BackboneElement	Composition is broken into sections Slice: Unordered, Closed by value:code, type:focus cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
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
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:vaccination	SC	1..1	BackboneElement	Vaccination Status Section cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
id		0..1	string	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	S	1..1	Reference(DVC Immunization)	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
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)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Composition.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Composition.status	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard
Composition.type	preferred	Pattern: LOINC Code 82593-5 http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard
Composition.category	example	DocumentClassValueSet http://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard
Composition.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Composition.confidentiality	required	v3.ConfidentialityClassification http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard
Composition.attester.mode	required	CompositionAttestationMode http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard
Composition.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard
Composition.event.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.code	example	DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard
Composition.section.mode	required	ListMode http://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard
Composition.section.orderedBy	preferred	ListOrderCodes http://hl7.org/fhir/ValueSet/list-order from the FHIR Standard
Composition.section.emptyReason	preferred	ListEmptyReasons http://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard
Composition.section:vaccination.code	example	Pattern: LOINC Code 11369-6 http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard
Composition.section:vaccination.mode	required	ListMode http://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard
Composition.section:vaccination.orderedBy	preferred	ListOrderCodes http://hl7.org/fhir/ValueSet/list-order from the FHIR Standard
Composition.section:vaccination.emptyReason	preferred	ListEmptyReasons http://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cmp-1	error	Composition.section, 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: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()

This structure is derived from Composition

Summary

Mandatory: 6 elements
Must-Support: 9 elements

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• DVC Patient (http://smart.who.int/icvp/StructureDefinition/DVCPatient)
• DVC Immunization (http://smart.who.int/icvp/StructureDefinition/DVC-ImmunizationUvIps)

Slices

This structure defines the following Slices:

• The element 2 is sliced based on the values of Composition.section (Closed)

Differential View

This structure is derived from Composition

Name	Flags	Card.	Type	Description & Constraints
Composition			Composition
text	S	0..1	Narrative	Text summary of the resource, for human interpretation
identifier	S	0..1	Identifier	Version-independent identifier for the Composition
status	S	1..1	code	preliminary | final | amended | entered-in-error
type	S	1..1	CodeableConceptIPS	Kind of composition ("DVC") Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 82593-5
subject	S	1..1	Reference(DVC Patient)	Who and/or what the composition is about
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
date	S	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		1..*	BackboneElement	Composition is broken into sections Slice: Unordered, Closed by value:code, type:focus
section:vaccination	S	1..1	BackboneElement	Vaccination Status Section
code		1..1	CodeableConcept	Classification of section (recommended) Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 11369-6
focus	S	1..1	Reference(DVC Immunization)	Who/what the section is about, when it is not about the subject of composition
entry		0..*	Reference(DVC Immunization)	A reference to data that supports this section
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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	S	0..1	Narrative	Text summary of the resource, for human interpretation
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
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 82593-5
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	1..*	BackboneElement	Composition is broken into sections Slice: Unordered, Closed by value:code, type:focus cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
section:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
section:vaccination	SC	1..1	BackboneElement	Vaccination Status Section cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
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
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 11369-6
focus	S	1..1	Reference(DVC Immunization)	Who/what the section is about, when it is not about the subject of composition
entry	C	0..*	Reference(DVC Immunization)	A reference to data that supports this section
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Composition.status	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard
Composition.type	preferred	Pattern: LOINC Code 82593-5 http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard
Composition.section:vaccination.code	example	Pattern: LOINC Code 11369-6 http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cmp-1	error	Composition.section, 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: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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text	S	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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	1..*	BackboneElement	Composition is broken into sections Slice: Unordered, Closed by value:code, type:focus cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
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
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:vaccination	SC	1..1	BackboneElement	Vaccination Status Section cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
id		0..1	string	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	S	1..1	Reference(DVC Immunization)	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
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)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Composition.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Composition.status	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard
Composition.type	preferred	Pattern: LOINC Code 82593-5 http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard
Composition.category	example	DocumentClassValueSet http://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard
Composition.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Composition.confidentiality	required	v3.ConfidentialityClassification http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard
Composition.attester.mode	required	CompositionAttestationMode http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard
Composition.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard
Composition.event.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.code	example	DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard
Composition.section.mode	required	ListMode http://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard
Composition.section.orderedBy	preferred	ListOrderCodes http://hl7.org/fhir/ValueSet/list-order from the FHIR Standard
Composition.section.emptyReason	preferred	ListEmptyReasons http://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard
Composition.section:vaccination.code	example	Pattern: LOINC Code 11369-6 http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard
Composition.section:vaccination.mode	required	ListMode http://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard
Composition.section:vaccination.orderedBy	preferred	ListOrderCodes http://hl7.org/fhir/ValueSet/list-order from the FHIR Standard
Composition.section:vaccination.emptyReason	preferred	ListEmptyReasons http://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cmp-1	error	Composition.section, 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: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()

This structure is derived from Composition

Summary

Mandatory: 6 elements
Must-Support: 9 elements

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• DVC Patient (http://smart.who.int/icvp/StructureDefinition/DVCPatient)
• DVC Immunization (http://smart.who.int/icvp/StructureDefinition/DVC-ImmunizationUvIps)

Slices

This structure defines the following Slices:

• The element 2 is sliced based on the values of Composition.section (Closed)

Other representations of profile: CSV, Excel, Schematron