RIVO-Noord Zorgviewer Implementation Guide
1.24.0 - CI build
RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.24.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/EncounterReport | Version: 1.24.0 | |||
| Draft as of 2026-03-31 | Computable Name: EncounterReport | |||
SOEPVerslag
Dit Profiel is het resultaat van de vergelijking tussen de zib2017 FHIR Profiel en de implementaties in Epic, Chipsoft, Topicus en Nexus. De elementen die in ieder geval in alle output beschikbaar zullen zijn. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.
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.
ViewDefinition voor EpisodeOfCare
Huisarts SOEP Verslagen
| >< | Bron | Datum | Titel | Auteur |
|---|---|---|---|---|
| + | CGM | 2012-08-10 | Contactverslag van Notitie/memo op 10 augustus 2012 met Pharmeon acceptatie zorg... | Pharmeon acceptatie zorgverlener |
| + | CGM | 2026-03-04 | Contactverslag van Consult op 4 maart 2026 met Pharmeon acceptatie zorgverlener | Pharmeon acceptatie zorgverlener |
|
Regels (P) Dit is een p - regel die wel zichtbaar wordt binnen H-EPD | ||||
| + | CGM | 2012-11-15 | Contactverslag van Notitie/memo op 15 november 2012 met Pharmeon acceptatie zorg... | Pharmeon acceptatie zorgverlener |
| + | CGM | 2011-04-20 | Contactverslag van Notitie/memo op 20 april 2011 met Pharmeon acceptatie zorgver... | Pharmeon acceptatie zorgverlener |
| + | CGM | 2011-04-20 | Contactverslag van Consult op 20 april 2011 met Pharmeon acceptatie zorgverlener | Pharmeon acceptatie zorgverlener |
|
Regels (P) verwijzing ziekenhuis voor gips | ||||
| + | CGM | 2026-03-04 | Contactverslag van Notitie/memo op 4 maart 2026 met Pharmeon acceptatie zorgverl... | Pharmeon acceptatie zorgverlener |
| + | CGM | 2026-03-04 | Contactverslag van Herhaalrecept op 4 maart 2026 met Pharmeon acceptatie zorgver... | Pharmeon acceptatie zorgverlener |
|
Regels (P) LISINOPRIL TABLET 10MG / 10,00 ST / 1D1T; VAN 4-3-2026 TOT 14-3-2026 | ||||
| + | CGM | 2023-06-03 | Contactverslag van Herhaalrecept op 3 juni 2023 met Pharmeon acceptatie zorgverl... | Pharmeon acceptatie zorgverlener |
|
Regels (P) HEPATITIS-A-VACCIN VAQTA JR WWSP 0,5ML (50E/ML) / 1,00 ST / GB | ||||
| + | CGM | 2025-03-11 | Contactverslag van Consult op 11 maart 2025 met Pharmeon acceptatie zorgverlener | Pharmeon acceptatie zorgverlener |
| + | CGM | 2026-03-04 | Contactverslag van Notitie/memo op 4 maart 2026 met Pharmeon acceptatie zorgverl... | Pharmeon acceptatie zorgverlener |
| + | CGM | 2026-03-04 | Contactverslag van Notitie/memo op 4 maart 2026 met Pharmeon acceptatie zorgverl... | Pharmeon acceptatie zorgverlener |
| + | CGM | 2026-03-04 | Contactverslag van Notitie/memo op 4 maart 2026 met Pharmeon acceptatie zorgverl... | Pharmeon acceptatie zorgverlener |
| + | CGM | 2026-02-26 | Contactverslag van Contact op 26 februari 2026 met Pharmeon acceptatie zorgverle... | Pharmeon acceptatie zorgverlener |
| + | Sanday | 2025-08-06T22:00:00+00:00 | Rughernia | J van der Vecht |
|
Regels (E) HNP (P) Nogmaals verwijzing Cesar | ||||
| Kolom label | FHIR Path Expression | FHIR Type | Zib element | Toelichting of regels |
|---|---|---|---|---|
| Bron | meta.extension('http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source').valueUri | string |
nvt | Lookup adhv uri (AGB-Z of OID) <adressering-base>/Organization?identifier=<.meta.tag.code> en gebruik dan Organization.name |
| Datum | date | string |
SOEPVerslagDatumTijd | |
| Titel | title | string |
nvt | |
| Auteur | author.display | string |
Auteur | |
| UITKLAPVELD | ||||
| +Regels | section.select('(' + code.coding.code + ') ' + text.`div`.replaceMatches('<[^>]*>', '')).join(' ') | string |
SOEPRegel | |
Opvragen (search) SOEP verslagen
GET <ontsluiten-bronsysteem-base>/Composition?patient=<fhir_patient_id>&type=http://loinc.org|67781-5
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.
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 1.23.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | gp EncounterReport | A set of resources composed into a single coherent clinical statement with clinical attestation | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred): Type of a composition. |
![]() ![]() |
Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about |
![]() ![]() |
Σ | 1..1 | Reference(gp-Encounter | HCIM Encounter) | Context of the Composition |
![]() ![]() |
SΣ | 1..1 | dateTime | Composition editing time |
![]() ![]() |
Σ | 1..* | Reference(nl-core-practitioner | HCIM MedicalDevice Product | nl-core-patient | nl-core-relatedperson) | Who and/or what authored the composition |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1 | |
![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource |
![]() ![]() |
SΣ | 1..1 | string | Human Readable name/title |
![]() ![]() |
?!Σ | 0..1 | code | As defined by affinity domain Binding: ConfidentialityClassification (required): Codes specifying the level of confidentiality of the composition. |
![]() ![]() |
C | 0..* | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/code-icpc-1-nl Constraints: ext-1 | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: JournaalregelType (required): Classification of a section of a composition/document. |
![]() ![]() ![]() |
SC | 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 |
![]() ![]() ![]() |
?!Σ | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. |
Documentation for this format | ||||
| 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. |
| 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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | gp EncounterReport | A set of resources composed into a single coherent clinical statement with clinical attestation | |
![]() ![]() |
S | 1..1 | dateTime | Composition editing time |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | string | Text alternative for the resource |
![]() ![]() |
S | 1..1 | string | Human Readable name/title |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of section (recommended) |
![]() ![]() ![]() |
S | 1..1 | Narrative | Text summary of the section, for human interpretation |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | gp EncounterReport | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Logical identifier of composition (version-independent) | ||||
![]() ![]() |
?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred): Type of a composition. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 67781-5 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Categorization of Composition Binding: FHIR Document Class Codes (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() |
Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about | ||||
![]() ![]() |
Σ | 1..1 | Reference(gp-Encounter | HCIM Encounter) | Context of the Composition | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | Composition editing time | ||||
![]() ![]() |
Σ | 1..* | Reference(nl-core-practitioner | HCIM MedicalDevice Product | nl-core-patient | nl-core-relatedperson) | Who and/or what authored the composition | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
SΣ | 1..1 | string | Human Readable name/title | ||||
![]() ![]() |
?!Σ | 0..1 | code | As defined by affinity domain Binding: ConfidentialityClassification (required): Codes specifying the level of confidentiality of the composition. | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Attests to accuracy of composition | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the composition was attested | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(nl-core-patient | nl-core-practitioner | nl-core-organization) | Who attested the composition | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | Reference(nl-core-organization) | Organization which maintains the composition | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Relationships to other compositions/documents | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Target of the relationship | |||||
![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() |
Reference(Composition) | |||||||
![]() ![]() |
Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | The period covered by the documentation | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
![]() ![]() |
C | 0..* | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/code-icpc-1-nl Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..1 | string | Label for section (e.g. for ToC) | |||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: JournaalregelType (required): Classification of a section of a composition/document. | ||||
![]() ![]() ![]() |
SC | 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 | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Order of section entries Binding: List Order Codes (preferred): What order applies to the items in the entry. | |||||
![]() ![]() ![]() |
C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the section is empty Binding: List Empty Reasons (preferred): If a section is empty, why it is empty. | ||||
![]() ![]() ![]() |
C | 0..* | See section (Composition) | Nested Section | ||||
Documentation for this format | ||||||||
| 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. |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | gp EncounterReport | A set of resources composed into a single coherent clinical statement with clinical attestation | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred): Type of a composition. |
![]() ![]() |
Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about |
![]() ![]() |
Σ | 1..1 | Reference(gp-Encounter | HCIM Encounter) | Context of the Composition |
![]() ![]() |
SΣ | 1..1 | dateTime | Composition editing time |
![]() ![]() |
Σ | 1..* | Reference(nl-core-practitioner | HCIM MedicalDevice Product | nl-core-patient | nl-core-relatedperson) | Who and/or what authored the composition |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1 | |
![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource |
![]() ![]() |
SΣ | 1..1 | string | Human Readable name/title |
![]() ![]() |
?!Σ | 0..1 | code | As defined by affinity domain Binding: ConfidentialityClassification (required): Codes specifying the level of confidentiality of the composition. |
![]() ![]() |
C | 0..* | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/code-icpc-1-nl Constraints: ext-1 | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: JournaalregelType (required): Classification of a section of a composition/document. |
![]() ![]() ![]() |
SC | 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 |
![]() ![]() ![]() |
?!Σ | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. |
Documentation for this format | ||||
| 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. |
| 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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | gp EncounterReport | A set of resources composed into a single coherent clinical statement with clinical attestation | |
![]() ![]() |
S | 1..1 | dateTime | Composition editing time |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | string | Text alternative for the resource |
![]() ![]() |
S | 1..1 | string | Human Readable name/title |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of section (recommended) |
![]() ![]() ![]() |
S | 1..1 | Narrative | Text summary of the section, for human interpretation |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | gp EncounterReport | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Logical identifier of composition (version-independent) | ||||
![]() ![]() |
?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred): Type of a composition. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 67781-5 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Categorization of Composition Binding: FHIR Document Class Codes (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() |
Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about | ||||
![]() ![]() |
Σ | 1..1 | Reference(gp-Encounter | HCIM Encounter) | Context of the Composition | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | Composition editing time | ||||
![]() ![]() |
Σ | 1..* | Reference(nl-core-practitioner | HCIM MedicalDevice Product | nl-core-patient | nl-core-relatedperson) | Who and/or what authored the composition | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
SΣ | 1..1 | string | Human Readable name/title | ||||
![]() ![]() |
?!Σ | 0..1 | code | As defined by affinity domain Binding: ConfidentialityClassification (required): Codes specifying the level of confidentiality of the composition. | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Attests to accuracy of composition | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the composition was attested | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(nl-core-patient | nl-core-practitioner | nl-core-organization) | Who attested the composition | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | Reference(nl-core-organization) | Organization which maintains the composition | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Relationships to other compositions/documents | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Target of the relationship | |||||
![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() |
Reference(Composition) | |||||||
![]() ![]() |
Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | The period covered by the documentation | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
![]() ![]() |
C | 0..* | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/code-icpc-1-nl Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..1 | string | Label for section (e.g. for ToC) | |||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: JournaalregelType (required): Classification of a section of a composition/document. | ||||
![]() ![]() ![]() |
SC | 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 | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Order of section entries Binding: List Order Codes (preferred): What order applies to the items in the entry. | |||||
![]() ![]() ![]() |
C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the section is empty Binding: List Empty Reasons (preferred): If a section is empty, why it is empty. | ||||
![]() ![]() ![]() |
C | 0..* | See section (Composition) | Nested Section | ||||
Documentation for this format | ||||||||
| 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. |
| 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
Other representations of profile: CSV, Excel, Schematron