Dit profiel is het resultaat van de vergelijking tussen de zib2017 STU3 en zibs2020 R4 FHIR Profiel, relevante informatiestandarden en de implementaties in de ontsloten systemen en instellingen. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.

Zorginformatiebouwsteen

N.B. SOEPVerslag komt uit de Huisartsgegevensset en is een zib2020 en FHIR R4. Voor het deel dat wij gebruiken is deze volledig compatibel met zib2017 en STU3.

ZIB SOEPVerslag

View Definition

ViewDefinition voor EncounterReport

UI Wireframe

Huisarts SOEP Verslagen

Gegevensherkomst

Request

1. Opvragen (search) SOEP verslagen

   GET <ontsluiten-bronsysteem-base>/Composition?patient=<fhir_patient_id>&type=http://loinc.org|67781-5

Bronsysteem herkennen

De Zorgviewer-backend of Ontsluiten bronsysteem MOET na bevragen van het bronsysteem aan elk resultaat resource een meta-tag toevoegen met de AGB, OID of URA identifier van de zorgaanbieder (zie Organization voor voorbeelden). Dit wordt vervolgens gebruikt in de "Bron" kolom in de Zorgviewer-frontend. N.B. We gebruiken hier een pre-adopt van de FHIR R4 Meta.source.

Toevoegen aan elke response, dus per resource (bij een read) of per Bundle (bij een search):

"meta": {
    "extension": [ {
        "url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source",
        "valueUri": "urn:oid:2.16.840.1.113883.2.4.3.8"
    } ]
}

Alternatief: Elke entry van een search response Bundle bevat een referentie naar de bijbehorende Patient (<resource>.subject|patient). Elke patient heeft een Patient.managingOrganization en in de gerefereerde Organization.identifier staat vervolgens o.a. de OID van het bronsysyeem. Of je gebruikt de identifiers om een volledige Organization op te zoeken in het adresboek en zie inhoud hier.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Composition		0..*	gp EncounterReport	A set of resources composed into a single coherent clinical statement with clinical attestation
Composition.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Composition.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Composition.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition.
Composition.type	Σ This element is included in summaries.	1..1	CodeableConcept	Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred): Type of a composition.
Composition.subject	Σ This element is included in summaries.	1..1	Reference(Resource)	Who and/or what the composition is about
Composition.encounter	Σ This element is included in summaries.	1..1	Reference(gp-Encounter | HCIM Encounter)	Context of the Composition
Composition.date	S This element must be supported. Σ This element is included in summaries.	1..1	dateTime	Composition editing time
Composition.author	Σ This element is included in summaries.	1..*	Reference(nl-core-practitioner | HCIM MedicalDevice Product | nl-core-patient | nl-core-relatedperson)	Who and/or what authored the composition
Composition.author.Slices for extension				Content/Rules for all slices
Composition.author.Slices for extension.extension:practitionerRole		0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
Composition.author.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Composition.title	S This element must be supported. Σ This element is included in summaries.	1..1	string	Human Readable name/title
Composition.confidentiality	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	As defined by affinity domain Binding: ConfidentialityClassification (required): Codes specifying the level of confidentiality of the composition.
Composition.section	C	0..*	BackboneElement	Composition is broken into sections Constraints: cmp-1, cmp-2
Composition.section.Slices for extension				Content/Rules for all slices
Composition.section.Slices for extension.extension:code_icpc_1_nl		0..1	CodeableConcept	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/code-icpc-1-nl Constraints: ext-1
Composition.section.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Composition.section.code	S This element must be supported.	1..1	CodeableConcept	Classification of section (recommended) Binding: JournaalregelType (required): Classification of a section of a composition/document.
Composition.section.text	S This element must be supported. C	1..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
Composition.section.mode	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Composition.status	Base	required	CompositionStatus	📦3.0.2	FHIR Std.
Composition.type	Base	preferred	FHIR Document Type Codes	📦3.0.2	FHIR Std.
Composition.confidentiality	Base	required	ConfidentialityClassification	📦2014-03-26	FHIR Std.
Composition.section.​code	Base	required	JournaalregelType	📦2011-10-12T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Composition.section.​mode	Base	required	ListMode	📦3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
cmp-1	error	Composition.section	A section must at least one of text, entries, or sub-sections	text.exists() or entry.exists() or section.exists()
cmp-2	error	Composition.section	A section can only have an emptyReason if it is empty	emptyReason.empty() or entry.empty()
dom-1	error	Composition	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.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	contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())
ext-1	error	Composition.author.extension:practitionerRole, Composition.section.extension:code_icpc_1_nl	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from gp EncounterReport

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Composition		0..*	gp EncounterReport	A set of resources composed into a single coherent clinical statement with clinical attestation
Composition.date	S This element must be supported.	1..1	dateTime	Composition editing time
Composition.author
Composition.author.display	S This element must be supported.	0..1	string	Text alternative for the resource
Composition.title	S This element must be supported.	1..1	string	Human Readable name/title
Composition.section
Composition.section.code	S This element must be supported.	1..1	CodeableConcept	Classification of section (recommended)
Composition.section.text	S This element must be supported.	1..1	Narrative	Text summary of the section, for human interpretation
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Composition		0..*	gp EncounterReport	A set of resources composed into a single coherent clinical statement with clinical attestation
Composition.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Composition.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Composition.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Composition.language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
Composition.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.contained		0..*	Resource	Contained, inline Resources
Composition.extension		0..*	Extension	Additional Content defined by implementations
Composition.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Composition.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical identifier of composition (version-independent)
Composition.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition.
Composition.type	Σ This element is included in summaries.	1..1	CodeableConcept	Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred): Type of a composition.
Composition.type.id		0..1	string	xml:id (or equivalent in JSON)
Composition.type.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Composition.type.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
Composition.type.coding.id		0..1	string	xml:id (or equivalent in JSON)
Composition.type.coding.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Composition.type.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system Fixed Value: http://loinc.org (no extensions allowed)
Composition.type.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Composition.type.coding.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system Fixed Value: 67781-5 (no extensions allowed)
Composition.type.coding.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Composition.type.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Composition.type.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Composition.class	Σ This element is included in summaries.	0..1	CodeableConcept	Categorization of Composition Binding: FHIR Document Class Codes (example): High-level kind of a clinical document at a macro level.
Composition.subject	Σ This element is included in summaries.	1..1	Reference(Resource)	Who and/or what the composition is about
Composition.encounter	Σ This element is included in summaries.	1..1	Reference(gp-Encounter | HCIM Encounter)	Context of the Composition
Composition.date	S This element must be supported. Σ This element is included in summaries.	1..1	dateTime	Composition editing time
Composition.author	Σ This element is included in summaries.	1..*	Reference(nl-core-practitioner | HCIM MedicalDevice Product | nl-core-patient | nl-core-relatedperson)	Who and/or what authored the composition
Composition.author.id		0..1	string	xml:id (or equivalent in JSON)
Composition.author.Slices for extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Composition.author.Slices for extension.extension:practitionerRole		0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
Composition.author.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Composition.author.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Composition.author.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Composition.title	S This element must be supported. Σ This element is included in summaries.	1..1	string	Human Readable name/title
Composition.confidentiality	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	As defined by affinity domain Binding: ConfidentialityClassification (required): Codes specifying the level of confidentiality of the composition.
Composition.attester	Σ This element is included in summaries.	0..*	BackboneElement	Attests to accuracy of composition
Composition.attester.id		0..1	string	xml:id (or equivalent in JSON)
Composition.attester.extension		0..*	Extension	Additional Content defined by implementations
Composition.attester.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Composition.attester.mode	Σ This element is included in summaries.	1..*	code	personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Composition.attester.time	Σ This element is included in summaries.	0..1	dateTime	When the composition was attested
Composition.attester.party	Σ This element is included in summaries.	0..1	Reference(nl-core-patient | nl-core-practitioner | nl-core-organization)	Who attested the composition
Composition.attester.party.id		0..1	string	xml:id (or equivalent in JSON)
Composition.attester.party.Slices for extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Composition.attester.party.Slices for extension.extension:practitionerRole		0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
Composition.attester.party.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Composition.attester.party.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Composition.attester.party.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Composition.custodian	Σ This element is included in summaries.	0..1	Reference(nl-core-organization)	Organization which maintains the composition
Composition.relatesTo	Σ This element is included in summaries.	0..*	BackboneElement	Relationships to other compositions/documents
Composition.relatesTo.id		0..1	string	xml:id (or equivalent in JSON)
Composition.relatesTo.extension		0..*	Extension	Additional Content defined by implementations
Composition.relatesTo.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Composition.relatesTo.code	Σ This element is included in summaries.	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
Composition.relatesTo.target[x]	Σ This element is included in summaries.	1..1		Target of the relationship
Composition.relatesTo.target[x].targetIdentifier			Identifier
Composition.relatesTo.target[x].targetReference			Reference(Composition)
Composition.event	Σ This element is included in summaries.	0..*	BackboneElement	The clinical service(s) being documented
Composition.event.id		0..1	string	xml:id (or equivalent in JSON)
Composition.event.extension		0..*	Extension	Additional Content defined by implementations
Composition.event.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Composition.event.code	Σ This element is included in summaries.	0..*	CodeableConcept	Code(s) that apply to the event being documented Binding: ActCode (example): This list of codes represents the main clinical acts being documented.
Composition.event.period	Σ This element is included in summaries.	0..1	Period	The period covered by the documentation
Composition.event.detail	Σ This element is included in summaries.	0..*	Reference(Resource)	The event(s) being documented
Composition.section	C	0..*	BackboneElement	Composition is broken into sections Constraints: cmp-1, cmp-2
Composition.section.id		0..1	string	xml:id (or equivalent in JSON)
Composition.section.Slices for extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Composition.section.Slices for extension.extension:code_icpc_1_nl		0..1	CodeableConcept	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/code-icpc-1-nl Constraints: ext-1
Composition.section.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Composition.section.title		0..1	string	Label for section (e.g. for ToC)
Composition.section.code	S This element must be supported.	1..1	CodeableConcept	Classification of section (recommended) Binding: JournaalregelType (required): Classification of a section of a composition/document.
Composition.section.text	S This element must be supported. C	1..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
Composition.section.mode	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section.
Composition.section.orderedBy		0..1	CodeableConcept	Order of section entries Binding: List Order Codes (preferred): What order applies to the items in the entry.
Composition.section.entry	C	0..*	Reference(Resource)	A reference to data that supports this section
Composition.section.emptyReason	C	0..1	CodeableConcept	Why the section is empty Binding: List Empty Reasons (preferred): If a section is empty, why it is empty.
Composition.section.section	C	0..*	See section (Composition)	Nested Section
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Composition.language	Base	extensible	Common Languages	📦3.0.2	FHIR Std.
Composition.status	Base	required	CompositionStatus	📦3.0.2	FHIR Std.
Composition.type	Base	preferred	FHIR Document Type Codes	📦3.0.2	FHIR Std.
Composition.class	Base	example	FHIR Document Class Codes	📦3.0.2	FHIR Std.
Composition.confidentiality	Base	required	ConfidentialityClassification	📦2014-03-26	FHIR Std.
Composition.attester.​mode	Base	required	CompositionAttestationMode	📦3.0.2	FHIR Std.
Composition.relatesTo.​code	Base	required	DocumentRelationshipType	📦3.0.2	FHIR Std.
Composition.event.code	Base	example	v3 Code System ActCode	📦2016-11-11	FHIR Std.
Composition.section.​code	Base	required	JournaalregelType	📦2011-10-12T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Composition.section.​mode	Base	required	ListMode	📦3.0.2	FHIR Std.
Composition.section.​orderedBy	Base	preferred	List Order Codes	📦3.0.2	FHIR Std.
Composition.section.​emptyReason	Base	preferred	List Empty Reasons	📦3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
cmp-1	error	Composition.section	A section must at least one of text, entries, or sub-sections	text.exists() or entry.exists() or section.exists()
cmp-2	error	Composition.section	A section can only have an emptyReason if it is empty	emptyReason.empty() or entry.empty()
dom-1	error	Composition	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.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	contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())
ext-1	error	Composition.author.extension:practitionerRole, Composition.attester.party.extension:practitionerRole, Composition.section.extension:code_icpc_1_nl	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Composition		0..*	gp EncounterReport	A set of resources composed into a single coherent clinical statement with clinical attestation
Composition.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Composition.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Composition.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition.
Composition.type	Σ This element is included in summaries.	1..1	CodeableConcept	Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred): Type of a composition.
Composition.subject	Σ This element is included in summaries.	1..1	Reference(Resource)	Who and/or what the composition is about
Composition.encounter	Σ This element is included in summaries.	1..1	Reference(gp-Encounter | HCIM Encounter)	Context of the Composition
Composition.date	S This element must be supported. Σ This element is included in summaries.	1..1	dateTime	Composition editing time
Composition.author	Σ This element is included in summaries.	1..*	Reference(nl-core-practitioner | HCIM MedicalDevice Product | nl-core-patient | nl-core-relatedperson)	Who and/or what authored the composition
Composition.author.Slices for extension				Content/Rules for all slices
Composition.author.Slices for extension.extension:practitionerRole		0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
Composition.author.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Composition.title	S This element must be supported. Σ This element is included in summaries.	1..1	string	Human Readable name/title
Composition.confidentiality	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	As defined by affinity domain Binding: ConfidentialityClassification (required): Codes specifying the level of confidentiality of the composition.
Composition.section	C	0..*	BackboneElement	Composition is broken into sections Constraints: cmp-1, cmp-2
Composition.section.Slices for extension				Content/Rules for all slices
Composition.section.Slices for extension.extension:code_icpc_1_nl		0..1	CodeableConcept	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/code-icpc-1-nl Constraints: ext-1
Composition.section.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Composition.section.code	S This element must be supported.	1..1	CodeableConcept	Classification of section (recommended) Binding: JournaalregelType (required): Classification of a section of a composition/document.
Composition.section.text	S This element must be supported. C	1..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
Composition.section.mode	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Composition.status	Base	required	CompositionStatus	📦3.0.2	FHIR Std.
Composition.type	Base	preferred	FHIR Document Type Codes	📦3.0.2	FHIR Std.
Composition.confidentiality	Base	required	ConfidentialityClassification	📦2014-03-26	FHIR Std.
Composition.section.​code	Base	required	JournaalregelType	📦2011-10-12T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Composition.section.​mode	Base	required	ListMode	📦3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
cmp-1	error	Composition.section	A section must at least one of text, entries, or sub-sections	text.exists() or entry.exists() or section.exists()
cmp-2	error	Composition.section	A section can only have an emptyReason if it is empty	emptyReason.empty() or entry.empty()
dom-1	error	Composition	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.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	contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())
ext-1	error	Composition.author.extension:practitionerRole, Composition.section.extension:code_icpc_1_nl	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Differential View

This structure is derived from gp EncounterReport

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Composition		0..*	gp EncounterReport	A set of resources composed into a single coherent clinical statement with clinical attestation
Composition.date	S This element must be supported.	1..1	dateTime	Composition editing time
Composition.author
Composition.author.display	S This element must be supported.	0..1	string	Text alternative for the resource
Composition.title	S This element must be supported.	1..1	string	Human Readable name/title
Composition.section
Composition.section.code	S This element must be supported.	1..1	CodeableConcept	Classification of section (recommended)
Composition.section.text	S This element must be supported.	1..1	Narrative	Text summary of the section, for human interpretation
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Composition		0..*	gp EncounterReport	A set of resources composed into a single coherent clinical statement with clinical attestation
Composition.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Composition.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Composition.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Composition.language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
Composition.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.contained		0..*	Resource	Contained, inline Resources
Composition.extension		0..*	Extension	Additional Content defined by implementations
Composition.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Composition.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical identifier of composition (version-independent)
Composition.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition.
Composition.type	Σ This element is included in summaries.	1..1	CodeableConcept	Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred): Type of a composition.
Composition.type.id		0..1	string	xml:id (or equivalent in JSON)
Composition.type.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Composition.type.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
Composition.type.coding.id		0..1	string	xml:id (or equivalent in JSON)
Composition.type.coding.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Composition.type.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system Fixed Value: http://loinc.org (no extensions allowed)
Composition.type.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Composition.type.coding.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system Fixed Value: 67781-5 (no extensions allowed)
Composition.type.coding.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Composition.type.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Composition.type.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Composition.class	Σ This element is included in summaries.	0..1	CodeableConcept	Categorization of Composition Binding: FHIR Document Class Codes (example): High-level kind of a clinical document at a macro level.
Composition.subject	Σ This element is included in summaries.	1..1	Reference(Resource)	Who and/or what the composition is about
Composition.encounter	Σ This element is included in summaries.	1..1	Reference(gp-Encounter | HCIM Encounter)	Context of the Composition
Composition.date	S This element must be supported. Σ This element is included in summaries.	1..1	dateTime	Composition editing time
Composition.author	Σ This element is included in summaries.	1..*	Reference(nl-core-practitioner | HCIM MedicalDevice Product | nl-core-patient | nl-core-relatedperson)	Who and/or what authored the composition
Composition.author.id		0..1	string	xml:id (or equivalent in JSON)
Composition.author.Slices for extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Composition.author.Slices for extension.extension:practitionerRole		0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
Composition.author.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Composition.author.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Composition.author.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Composition.title	S This element must be supported. Σ This element is included in summaries.	1..1	string	Human Readable name/title
Composition.confidentiality	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	As defined by affinity domain Binding: ConfidentialityClassification (required): Codes specifying the level of confidentiality of the composition.
Composition.attester	Σ This element is included in summaries.	0..*	BackboneElement	Attests to accuracy of composition
Composition.attester.id		0..1	string	xml:id (or equivalent in JSON)
Composition.attester.extension		0..*	Extension	Additional Content defined by implementations
Composition.attester.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Composition.attester.mode	Σ This element is included in summaries.	1..*	code	personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Composition.attester.time	Σ This element is included in summaries.	0..1	dateTime	When the composition was attested
Composition.attester.party	Σ This element is included in summaries.	0..1	Reference(nl-core-patient | nl-core-practitioner | nl-core-organization)	Who attested the composition
Composition.attester.party.id		0..1	string	xml:id (or equivalent in JSON)
Composition.attester.party.Slices for extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Composition.attester.party.Slices for extension.extension:practitionerRole		0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
Composition.attester.party.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Composition.attester.party.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Composition.attester.party.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Composition.custodian	Σ This element is included in summaries.	0..1	Reference(nl-core-organization)	Organization which maintains the composition
Composition.relatesTo	Σ This element is included in summaries.	0..*	BackboneElement	Relationships to other compositions/documents
Composition.relatesTo.id		0..1	string	xml:id (or equivalent in JSON)
Composition.relatesTo.extension		0..*	Extension	Additional Content defined by implementations
Composition.relatesTo.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Composition.relatesTo.code	Σ This element is included in summaries.	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
Composition.relatesTo.target[x]	Σ This element is included in summaries.	1..1		Target of the relationship
Composition.relatesTo.target[x].targetIdentifier			Identifier
Composition.relatesTo.target[x].targetReference			Reference(Composition)
Composition.event	Σ This element is included in summaries.	0..*	BackboneElement	The clinical service(s) being documented
Composition.event.id		0..1	string	xml:id (or equivalent in JSON)
Composition.event.extension		0..*	Extension	Additional Content defined by implementations
Composition.event.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Composition.event.code	Σ This element is included in summaries.	0..*	CodeableConcept	Code(s) that apply to the event being documented Binding: ActCode (example): This list of codes represents the main clinical acts being documented.
Composition.event.period	Σ This element is included in summaries.	0..1	Period	The period covered by the documentation
Composition.event.detail	Σ This element is included in summaries.	0..*	Reference(Resource)	The event(s) being documented
Composition.section	C	0..*	BackboneElement	Composition is broken into sections Constraints: cmp-1, cmp-2
Composition.section.id		0..1	string	xml:id (or equivalent in JSON)
Composition.section.Slices for extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Composition.section.Slices for extension.extension:code_icpc_1_nl		0..1	CodeableConcept	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/code-icpc-1-nl Constraints: ext-1
Composition.section.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Composition.section.title		0..1	string	Label for section (e.g. for ToC)
Composition.section.code	S This element must be supported.	1..1	CodeableConcept	Classification of section (recommended) Binding: JournaalregelType (required): Classification of a section of a composition/document.
Composition.section.text	S This element must be supported. C	1..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
Composition.section.mode	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section.
Composition.section.orderedBy		0..1	CodeableConcept	Order of section entries Binding: List Order Codes (preferred): What order applies to the items in the entry.
Composition.section.entry	C	0..*	Reference(Resource)	A reference to data that supports this section
Composition.section.emptyReason	C	0..1	CodeableConcept	Why the section is empty Binding: List Empty Reasons (preferred): If a section is empty, why it is empty.
Composition.section.section	C	0..*	See section (Composition)	Nested Section
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Composition.language	Base	extensible	Common Languages	📦3.0.2	FHIR Std.
Composition.status	Base	required	CompositionStatus	📦3.0.2	FHIR Std.
Composition.type	Base	preferred	FHIR Document Type Codes	📦3.0.2	FHIR Std.
Composition.class	Base	example	FHIR Document Class Codes	📦3.0.2	FHIR Std.
Composition.confidentiality	Base	required	ConfidentialityClassification	📦2014-03-26	FHIR Std.
Composition.attester.​mode	Base	required	CompositionAttestationMode	📦3.0.2	FHIR Std.
Composition.relatesTo.​code	Base	required	DocumentRelationshipType	📦3.0.2	FHIR Std.
Composition.event.code	Base	example	v3 Code System ActCode	📦2016-11-11	FHIR Std.
Composition.section.​code	Base	required	JournaalregelType	📦2011-10-12T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Composition.section.​mode	Base	required	ListMode	📦3.0.2	FHIR Std.
Composition.section.​orderedBy	Base	preferred	List Order Codes	📦3.0.2	FHIR Std.
Composition.section.​emptyReason	Base	preferred	List Empty Reasons	📦3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
cmp-1	error	Composition.section	A section must at least one of text, entries, or sub-sections	text.exists() or entry.exists() or section.exists()
cmp-2	error	Composition.section	A section can only have an emptyReason if it is empty	emptyReason.empty() or entry.empty()
dom-1	error	Composition	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.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	contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())
ext-1	error	Composition.author.extension:practitionerRole, Composition.attester.party.extension:practitionerRole, Composition.section.extension:code_icpc_1_nl	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from gp EncounterReport

Summary

Must-Support: 5 elements