RIVO-Noord Zorgviewer Implementation Guide
1.25.0 - 383208
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.25.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/ContactenAfspraken | Version: 1.25.0 | |||
| Active as of 2026-08-04 | Computable Name: ContactenAfspraken | |||
Contacten en Afspraken samenstelling voor het documenteren van de combinatie van Contact en Afspraak
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.
De specificatie op deze pagina is work-in-progress.
ViewDefinition voor Contacten en Afspraken
Contacten en Afspraken
| >< | Bron | Begin | Eind | Met | Locatie | Status | Type | Reden |
|---|---|---|---|---|---|---|---|---|
| + | CGM | 15-7-2026 | 15-7-2026 | Pharmeon acceptatie zorgverlener Huisartsen, niet apotheekhoudend |
booked | e-consult | ||
| + | WZA | 13-7-2026 | 13-7-2026 | M.C. Gordinou de Gouberville Onbekende functiecode. |
Wilhelmina Ziekenhuis | pending | Ambulatory | Niet beschikbaar |
| + | CGM | 4-3-2026 | 4-3-2026 | Pharmeon acceptatie zorgverlener Huisartsen, niet apotheekhoudend |
finished | Ambulatory notitie/memo | ||
| + | CGM | 26-2-2026 | 26-2-2026 | Pharmeon acceptatie zorgverlener Huisartsen, niet apotheekhoudend |
finished | Ambulatory Anders | ||
| + | CGM | 30-9-2025 | 30-9-2025 | Pharmeon acceptatie zorgverlener Huisartsen, niet apotheekhoudend |
finished | Ambulatory e-consult | ||
| + | Epic | 27-3-2025 | 27-3-2025 | E. Sieders, Chirurg DJA. de Groot, Internist Oncoloog A. (van Donderen-) Vrieze ... |
UMCG HC | unknown | Inpatient Encounter Chirurgie | |
| + | CGM | 11-3-2025 | 11-3-2025 | Pharmeon acceptatie zorgverlener Huisartsen, niet apotheekhoudend |
finished | Ambulatory consult | ||
| + | Sanday | 4-7-2024 | finished | Other | Keelpijn | |||
| + | Chipsoft | 12-10-2022 | 12-10-2022 | Ziekenhuis Apotheek | pending | Ambulatory | Niet beschikbaar | |
| + | Epic | 20-4-2018 | 20-4-2018 | G. Dijkstra, MDL arts | Maag- Darm- Leverziekten | pending | Ambulatory | |
| + | CGM | 15-11-2012 | 15-11-2012 | Pharmeon acceptatie zorgverlener Huisartsen, niet apotheekhoudend |
finished | Ambulatory notitie/memo | ||
| + | Nexus | 16-8-2012 | 19-8-2012 | Wit Orthopedie |
finished | Klinisch | ||
| + | Chipsoft | 14-8-2012 | 15-8-2012 | J.H.R Peters Onbekende functiecode. |
finished | inpatient | other | |
| + | CGM | 10-8-2012 | 10-8-2012 | Pharmeon acceptatie zorgverlener Huisartsen, niet apotheekhoudend |
finished | Ambulatory notitie/memo | ||
| + | CGM | 20-4-2011 | 20-4-2011 | Pharmeon acceptatie zorgverlener Huisartsen, niet apotheekhoudend |
finished | Ambulatory notitie/memo | ||
| + | CGM | 20-4-2011 | 20-4-2011 | Pharmeon acceptatie zorgverlener Huisartsen, niet apotheekhoudend |
finished | Ambulatory consult | ||
| Kolom label | FHIR Path Expression | FHIR Type | Zib element | Toelichting of regels |
|---|---|---|---|---|
| Encounter | ||||
| 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 |
| Begin | period.start | dateTime |
BeginDatumTijd | |
| Eind | period.end | dateTime |
EindDatumTijd | |
| Met | participant.individual.select(display | extension('http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference').valueReference.display).join(' ') | string |
ContactMet::Zorgverlener, ContactMet::Zorgverlener/ZorgverlenersRol | |
| Locatie | location.location.display | string |
Locatie::Zorgaanbieder | |
| Status | status | code |
nvt | |
| Type | class.display + iif(exists(type), ' ' + (type.text | type.coding.display), '') | code |
ContactType | |
| Reden | episodeOfCare.display | reason.text | diagnosis.condition.display | string |
nvt | Uit huisarts gekoppelde Episode or DeviatingResult or Problem or Condition |
| Appointment' and (status='proposed' or status='pending' or status='booked | ||||
| 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 |
| Begin | start | dateTime |
BeginDatumTijd | |
| Eind | end | dateTime |
EindDatumTijd | |
| Met | participant.actor.where(reference.contains('Practitioner/')).select(display | extension('http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference').valueReference.display).join(' ') | string |
ContactMet::Zorgverlener, ContactMet::Zorgverlener/ZorgverlenersRol | |
| Locatie | participant.actor.where(reference.contains('Location/'))[0].display | string |
Locatie::Zorgaanbieder | |
| Status | status | code |
nvt | |
| Type | appointmentType.coding.display | string |
ContactType | |
| Reden | reason.text | indication.display | string |
nvt | DeviatingResult or Problem or Condition n.b. dit is geen ZIB. |
Er is geen request waarmee je beide resources in 1 keer kan opvragen. Je moet hiervoor dus een request doen per resource.
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 1.24.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle | This is an abstract profile. Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-1, bdl-2 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. |
![]() ![]() |
ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource Constraints: bdl-8, bdl-5 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Encounter Constraints: bdl-8, bdl-5 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Encounter | Encounter |
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Appointment Constraints: bdl-8, bdl-5 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request only for some types of bundles |
entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
|
| bdl-4 | error | Bundle | entry.response only for some types of bundles |
entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
|
| bdl-5 | error | Bundle.entry, Bundle.entry:Encounter, Bundle.entry:Appointment | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId |
entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:Encounter, Bundle.entry:Appointment | fullUrl cannot be a version specific reference |
fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Bundle | This is an abstract profile. Contains a collection of resources | |
![]() ![]() |
0..* | BackboneElement | Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource | |
![]() ![]() ![]() |
0..* | BackboneElement | Encounter | |
![]() ![]() ![]() ![]() |
1..1 | Encounter | Encounter | |
![]() ![]() ![]() |
0..* | BackboneElement | Appointment | |
![]() ![]() ![]() ![]() |
1..1 | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Bundle | This is an abstract profile. Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-1, bdl-2 | ||||
![]() ![]() |
Σ | 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 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() |
Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. | ||||
![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]() |
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 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]() |
ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource Constraints: bdl-8, bdl-5 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Absolute URL for resource (server address, or UUID/OID) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
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 | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location, if the operation returns a location | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Encounter Constraints: bdl-8, bdl-5 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Absolute URL for resource (server address, or UUID/OID) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Encounter | Encounter | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
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 | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location, if the operation returns a location | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Appointment Constraints: bdl-8, bdl-5 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Absolute URL for resource (server address, or UUID/OID) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
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 | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location, if the operation returns a location | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() |
Σ | 0..1 | Signature | Digital Signature | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | extensible | Common Languages | 📍3.0.2 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍3.0.2 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍3.0.2 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍3.0.2 | FHIR Std. |
| Bundle.entry:Encounter.search.mode | Base | required | SearchEntryMode | 📍3.0.2 | FHIR Std. |
| Bundle.entry:Encounter.request.method | Base | required | HTTPVerb | 📍3.0.2 | FHIR Std. |
| Bundle.entry:Appointment.search.mode | Base | required | SearchEntryMode | 📍3.0.2 | FHIR Std. |
| Bundle.entry:Appointment.request.method | Base | required | HTTPVerb | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request only for some types of bundles |
entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
|
| bdl-4 | error | Bundle | entry.response only for some types of bundles |
entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
|
| bdl-5 | error | Bundle.entry, Bundle.entry:Encounter, Bundle.entry:Appointment | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId |
entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:Encounter, Bundle.entry:Appointment | fullUrl cannot be a version specific reference |
fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
This structure is derived from Bundle
Summary
Mandatory: 0 element(2 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle | This is an abstract profile. Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-1, bdl-2 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. |
![]() ![]() |
ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource Constraints: bdl-8, bdl-5 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Encounter Constraints: bdl-8, bdl-5 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Encounter | Encounter |
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Appointment Constraints: bdl-8, bdl-5 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request only for some types of bundles |
entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
|
| bdl-4 | error | Bundle | entry.response only for some types of bundles |
entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
|
| bdl-5 | error | Bundle.entry, Bundle.entry:Encounter, Bundle.entry:Appointment | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId |
entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:Encounter, Bundle.entry:Appointment | fullUrl cannot be a version specific reference |
fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Bundle | This is an abstract profile. Contains a collection of resources | |
![]() ![]() |
0..* | BackboneElement | Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource | |
![]() ![]() ![]() |
0..* | BackboneElement | Encounter | |
![]() ![]() ![]() ![]() |
1..1 | Encounter | Encounter | |
![]() ![]() ![]() |
0..* | BackboneElement | Appointment | |
![]() ![]() ![]() ![]() |
1..1 | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Bundle | This is an abstract profile. Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-1, bdl-2 | ||||
![]() ![]() |
Σ | 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 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() |
Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. | ||||
![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]() |
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 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]() |
ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource Constraints: bdl-8, bdl-5 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Absolute URL for resource (server address, or UUID/OID) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
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 | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location, if the operation returns a location | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Encounter Constraints: bdl-8, bdl-5 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Absolute URL for resource (server address, or UUID/OID) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Encounter | Encounter | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
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 | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location, if the operation returns a location | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Appointment Constraints: bdl-8, bdl-5 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Absolute URL for resource (server address, or UUID/OID) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
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 | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location, if the operation returns a location | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() |
Σ | 0..1 | Signature | Digital Signature | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | extensible | Common Languages | 📍3.0.2 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍3.0.2 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍3.0.2 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍3.0.2 | FHIR Std. |
| Bundle.entry:Encounter.search.mode | Base | required | SearchEntryMode | 📍3.0.2 | FHIR Std. |
| Bundle.entry:Encounter.request.method | Base | required | HTTPVerb | 📍3.0.2 | FHIR Std. |
| Bundle.entry:Appointment.search.mode | Base | required | SearchEntryMode | 📍3.0.2 | FHIR Std. |
| Bundle.entry:Appointment.request.method | Base | required | HTTPVerb | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request only for some types of bundles |
entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
|
| bdl-4 | error | Bundle | entry.response only for some types of bundles |
entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
|
| bdl-5 | error | Bundle.entry, Bundle.entry:Encounter, Bundle.entry:Appointment | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId |
entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:Encounter, Bundle.entry:Appointment | fullUrl cannot be a version specific reference |
fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
This structure is derived from Bundle
Summary
Mandatory: 0 element(2 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron