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.

Zorginformatiebouwstenen

De volgende zibs vallen min of meer onder het thema middelengebruik.

• ZIB Alcoholgebruik - BgZ
• ZIB Drugsgebruik - BgZ
• ZIB Tabakgebruik - BgZ
• ZIB AlgemeneMeting - Huisartsgegevens

View Definition

ViewDefinition voor middelengebruik

UI Wireframe

Middelengebruik

Kolomdefinities

Request

N.B. BgZ gebruikt de categorie 'social-history' en HIS'en gebruiken 'vital-signs' voor het middelengebruik. Bij deze algemene queries komen altijd teveel gegevens terug.

1. Opvragen (search) middelengebruik (BgZ)

   GET <ontsluiten-bronsysteem-base>/Observation?patient=<fhir_patient_id>&category=social-history

2. Opvragen (search) middelengebruik (huisartsgegevens)

   GET <ontsluiten-bronsysteem-base>/Observation?patient=<fhir_patient_id>&category=vital-signs

3. Opvragen (search) alcoholgebruik (BgZ)

   GET <ontsluiten-bronsysteem-base>/Observation?patient=<fhir_patient_id>&code=http://snomed.info/sct|228273003

4. Opvragen (search) alcoholgebruik (huisartsgegevens). HIS'en includeren ook de FiveShot vragenlijst antwoorden. Let op dat de komma-notatie van codes niet altijd wordt ondersteund.

   GET <ontsluiten-bronsysteem-base>/Observation?patient=<fhir_patient_id>&code=https://referentiemodel.nhg.org/tabellen/nhg-tabel-45-diagnostische-bepalingen|1591,https://referentiemodel.nhg.org/tabellen/nhg-tabel-45-diagnostische-bepalingen|2418,https://referentiemodel.nhg.org/tabellen/nhg-tabel-45-diagnostische-bepalingen|2419,https://referentiemodel.nhg.org/tabellen/nhg-tabel-45-diagnostische-bepalingen|2420,https://referentiemodel.nhg.org/tabellen/nhg-tabel-45-diagnostische-bepalingen|2421,https://referentiemodel.nhg.org/tabellen/nhg-tabel-45-diagnostische-bepalingen|2422

5. CGM: Opvragen (search) alcoholgebruik. CGM slaat alcoholgebruik op zonder SNOMED-CT code; gebruik NHG Tabel 45 code 1591.

   GET <ontsluiten-bronsysteem-base>/Observation?patient=<fhir_patient_id>&code=https://referentiemodel.nhg.org/tabellen/nhg-tabel-45-diagnostische-bepalingen|1591

6. Opvragen (search) drugsgebruik (Epic/CGM)

   GET <ontsluiten-bronsysteem-base>/Observation?patient=<fhir_patient_id>&code=http://snomed.info/sct|228366006

7. Opvragen (search) drugsgebruik (Sanday/CGM)

   GET <ontsluiten-bronsysteem-base>/Observation?patient=<fhir_patient_id>&code=https://referentiemodel.nhg.org/tabellen/nhg-tabel-45-diagnostische-bepalingen|3022

8. Opvragen (search) tabakgebruik (Epic/CGM)

   GET <ontsluiten-bronsysteem-base>/Observation?patient=<fhir_patient_id>&code=http://snomed.info/sct|365980008

9. Opvragen (search) tabakgebruik (Sanday/CGM)

   GET <ontsluiten-bronsysteem-base>/Observation?patient=<fhir_patient_id>&code=https://referentiemodel.nhg.org/tabellen/nhg-tabel-45-diagnostische-bepalingen|1739

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.

Changes since version 1.24.0:

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
type	Σ	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.
Slices for entry	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource Constraints: bdl-8, bdl-5
entry:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
entry:TobaccoUse	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Constraints: bdl-8, bdl-5
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
resource	Σ	1..1	TobaccoUse	TobaccoUse
entry:AlcoholUse	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Constraints: bdl-8, bdl-5
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
resource	Σ	1..1	AlcoholUse	AlcoholUse
entry:DrugUse	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Constraints: bdl-8, bdl-5
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
resource	Σ	1..1	DrugUse	DrugUse
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.type	Base	required	BundleType	📍3.0.2	FHIR Std.

Constraints

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:TobaccoUse, Bundle.entry:AlcoholUse, Bundle.entry:DrugUse	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:TobaccoUse, Bundle.entry:AlcoholUse, Bundle.entry:DrugUse	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: Bindings Constraints Obligations
Bundle		0..*	Bundle	This is an abstract profile. Contains a collection of resources
Slices for entry		0..*	BackboneElement	Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource
entry:TobaccoUse		0..*	BackboneElement	Entry in the bundle - will have a resource, or information
resource		1..1	TobaccoUse	TobaccoUse
entry:AlcoholUse		0..*	BackboneElement	Entry in the bundle - will have a resource, or information
resource		1..1	AlcoholUse	AlcoholUse
entry:DrugUse		0..*	BackboneElement	Entry in the bundle - will have a resource, or information
resource		1..1	DrugUse	DrugUse
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	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
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
identifier	Σ	0..1	Identifier	Persistent identifier for the bundle
type	Σ	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.
total	ΣC	0..1	unsignedInt	If search, the total number of matches
link	Σ	0..*	BackboneElement	Links related to this Bundle
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
relation	Σ	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Σ	1..1	uri	Reference details for the link
Slices for entry	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource Constraints: bdl-8, bdl-5
entry:All Slices				Content/Rules for all slices
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	Absolute URL for resource (server address, or UUID/OID)
resource	Σ	0..1	Resource	A resource in the bundle
search	ΣC	0..1	BackboneElement	Search related information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
mode	Σ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
request	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
method	Σ	1..1	code	GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing update contention
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location, if the operation returns a location
etag	Σ	0..1	string	The etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:TobaccoUse	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Constraints: bdl-8, bdl-5
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	Absolute URL for resource (server address, or UUID/OID)
resource	Σ	1..1	TobaccoUse	TobaccoUse
search	ΣC	0..1	BackboneElement	Search related information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
mode	Σ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
request	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
method	Σ	1..1	code	GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing update contention
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location, if the operation returns a location
etag	Σ	0..1	string	The etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:AlcoholUse	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Constraints: bdl-8, bdl-5
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	Absolute URL for resource (server address, or UUID/OID)
resource	Σ	1..1	AlcoholUse	AlcoholUse
search	ΣC	0..1	BackboneElement	Search related information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
mode	Σ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
request	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
method	Σ	1..1	code	GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing update contention
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location, if the operation returns a location
etag	Σ	0..1	string	The etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:DrugUse	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Constraints: bdl-8, bdl-5
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	Absolute URL for resource (server address, or UUID/OID)
resource	Σ	1..1	DrugUse	DrugUse
search	ΣC	0..1	BackboneElement	Search related information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
mode	Σ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
request	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
method	Σ	1..1	code	GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing update contention
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location, if the operation returns a location
etag	Σ	0..1	string	The etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

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:TobaccoUse.​search.mode	Base	required	SearchEntryMode	📍3.0.2	FHIR Std.
Bundle.entry:TobaccoUse.​request.method	Base	required	HTTPVerb	📍3.0.2	FHIR Std.
Bundle.entry:AlcoholUse.​search.mode	Base	required	SearchEntryMode	📍3.0.2	FHIR Std.
Bundle.entry:AlcoholUse.​request.method	Base	required	HTTPVerb	📍3.0.2	FHIR Std.
Bundle.entry:DrugUse.​search.mode	Base	required	SearchEntryMode	📍3.0.2	FHIR Std.
Bundle.entry:DrugUse.​request.method	Base	required	HTTPVerb	📍3.0.2	FHIR Std.

Constraints

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:TobaccoUse, Bundle.entry:AlcoholUse, Bundle.entry:DrugUse	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:TobaccoUse, Bundle.entry:AlcoholUse, Bundle.entry:DrugUse	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())

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
type	Σ	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.
Slices for entry	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource Constraints: bdl-8, bdl-5
entry:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
entry:TobaccoUse	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Constraints: bdl-8, bdl-5
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
resource	Σ	1..1	TobaccoUse	TobaccoUse
entry:AlcoholUse	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Constraints: bdl-8, bdl-5
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
resource	Σ	1..1	AlcoholUse	AlcoholUse
entry:DrugUse	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Constraints: bdl-8, bdl-5
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
resource	Σ	1..1	DrugUse	DrugUse
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.type	Base	required	BundleType	📍3.0.2	FHIR Std.

Constraints

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:TobaccoUse, Bundle.entry:AlcoholUse, Bundle.entry:DrugUse	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:TobaccoUse, Bundle.entry:AlcoholUse, Bundle.entry:DrugUse	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: Bindings Constraints Obligations
Bundle		0..*	Bundle	This is an abstract profile. Contains a collection of resources
Slices for entry		0..*	BackboneElement	Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource
entry:TobaccoUse		0..*	BackboneElement	Entry in the bundle - will have a resource, or information
resource		1..1	TobaccoUse	TobaccoUse
entry:AlcoholUse		0..*	BackboneElement	Entry in the bundle - will have a resource, or information
resource		1..1	AlcoholUse	AlcoholUse
entry:DrugUse		0..*	BackboneElement	Entry in the bundle - will have a resource, or information
resource		1..1	DrugUse	DrugUse
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	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
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
identifier	Σ	0..1	Identifier	Persistent identifier for the bundle
type	Σ	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.
total	ΣC	0..1	unsignedInt	If search, the total number of matches
link	Σ	0..*	BackboneElement	Links related to this Bundle
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
relation	Σ	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Σ	1..1	uri	Reference details for the link
Slices for entry	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource Constraints: bdl-8, bdl-5
entry:All Slices				Content/Rules for all slices
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	Absolute URL for resource (server address, or UUID/OID)
resource	Σ	0..1	Resource	A resource in the bundle
search	ΣC	0..1	BackboneElement	Search related information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
mode	Σ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
request	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
method	Σ	1..1	code	GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing update contention
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location, if the operation returns a location
etag	Σ	0..1	string	The etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:TobaccoUse	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Constraints: bdl-8, bdl-5
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	Absolute URL for resource (server address, or UUID/OID)
resource	Σ	1..1	TobaccoUse	TobaccoUse
search	ΣC	0..1	BackboneElement	Search related information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
mode	Σ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
request	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
method	Σ	1..1	code	GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing update contention
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location, if the operation returns a location
etag	Σ	0..1	string	The etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:AlcoholUse	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Constraints: bdl-8, bdl-5
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	Absolute URL for resource (server address, or UUID/OID)
resource	Σ	1..1	AlcoholUse	AlcoholUse
search	ΣC	0..1	BackboneElement	Search related information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
mode	Σ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
request	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
method	Σ	1..1	code	GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing update contention
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location, if the operation returns a location
etag	Σ	0..1	string	The etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:DrugUse	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource, or information Constraints: bdl-8, bdl-5
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	Absolute URL for resource (server address, or UUID/OID)
resource	Σ	1..1	DrugUse	DrugUse
search	ΣC	0..1	BackboneElement	Search related information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
mode	Σ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
request	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
method	Σ	1..1	code	GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing update contention
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location, if the operation returns a location
etag	Σ	0..1	string	The etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

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:TobaccoUse.​search.mode	Base	required	SearchEntryMode	📍3.0.2	FHIR Std.
Bundle.entry:TobaccoUse.​request.method	Base	required	HTTPVerb	📍3.0.2	FHIR Std.
Bundle.entry:AlcoholUse.​search.mode	Base	required	SearchEntryMode	📍3.0.2	FHIR Std.
Bundle.entry:AlcoholUse.​request.method	Base	required	HTTPVerb	📍3.0.2	FHIR Std.
Bundle.entry:DrugUse.​search.mode	Base	required	SearchEntryMode	📍3.0.2	FHIR Std.
Bundle.entry:DrugUse.​request.method	Base	required	HTTPVerb	📍3.0.2	FHIR Std.

Constraints

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:TobaccoUse, Bundle.entry:AlcoholUse, Bundle.entry:DrugUse	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:TobaccoUse, Bundle.entry:AlcoholUse, Bundle.entry:DrugUse	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(3 nested mandatory elements)

Structures

This structure refers to these other structures:

• TobaccoUse (http://fhir.hl7.nl/zorgviewer/StructureDefinition/TobaccoUse)
• AlcoholUse (http://fhir.hl7.nl/zorgviewer/StructureDefinition/AlcoholUse)
• DrugUse (http://fhir.hl7.nl/zorgviewer/StructureDefinition/DrugUse)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Bundle.entry