RIVO-Noord Zorgviewer Implementation Guide
1.27.0 - master Netherlands flag

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.27.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

Resource Profile: Correspondentie en Verslagen ( Abstract )

Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/Correspondentie Version: 1.27.0
Active as of 2026-10-22 Computable Name: Correspondentie

Correspondentie samenstelling voor het documenteren van de combinatie van DocumentReference, Composition (SOEP Verslagen) en Observation (Verpleegkundige Rapportages).

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

Zorginformatiebouwsteen

View Definition

ViewDefinition voor Correspondentie

UI Wireframe

Correspondentie en Verslagen

Bron Datum Beschrijving Auteur Specialisme (MimeType) (Type)
▼ NedapONS 26-8-2026 Roald Dahl van Externe ANW Organisatie VVT plain/text Rapportage
Verslag
Via ANW-zorg:

Nog een laatste test met koppelingen
▼ NedapONS 26-8-2026 Bastienne Bos van Externe ANW Organisatie VVT plain/text Rapportage
Verslag
Via ANW-zorg:

Niet op mijn naam!
▼ NedapONS 25-8-2026 Roald Dahl van Externe ANW Organisatie VVT plain/text Rapportage
Verslag
Via ANW-zorg:

Ik ben 15 minuten bezig geweest met een bloeddruk meting
▼ NedapONS 23-6-2026 Roald Dijkstra van Externe ANW Organisatie VVT plain/text Rapportage
Verslag
Via ANW-zorg:

Test voor tijdschrijven
▼ NedapONS 9-6-2026 Bastienne Bos van Externe ANW Organisatie VVT plain/text Rapportage
Verslag
Via ANW-zorg:

Test om 13:48
▼ NedapONS 15-5-2026 Bastienne Bos van Externe ANW Organisatie VVT plain/text Rapportage
Verslag
Via ANW-zorg:

Meneer kan weer lopen
▼ NedapONS 29-4-2026 Roald Dijkstra van Externe ANW Organisatie VVT plain/text Rapportage
Verslag
Via ANW-zorg:

Test voor tijdschrijven
▼ NedapONS 29-4-2026 Roald Dijkstra van Externe ANW Organisatie VVT plain/text Rapportage
Verslag
Via ANW-zorg:

Test
▼ NedapONS 13-4-2026 Arthur Wolters van Externe ANW Organisatie VVT plain/text Rapportage
Verslag
Via ANW-zorg:

tttest
▼ NedapONS 13-4-2026 Arthur Wolters van Externe ANW Organisatie VVT plain/text Rapportage
Verslag
Via ANW-zorg:

tijd reg teeeest
▼ CGM 4-3-2026 Contactverslag van Consult op 4 maart 2026 met Pharmeon acceptatie zorgverlener Pharmeon acceptatie zorgverlener Huisarts plain/text 67781-5
Regels
(P) Dit is een p - regel die wel zichtbaar wordt binnen H-EPD
▼ CGM 4-3-2026 Contactverslag van Notitie/memo op 4 maart 2026 met Pharmeon acceptatie zorgverl... Pharmeon acceptatie zorgverlener Huisarts plain/text 67781-5
▼ CGM 4-3-2026 Contactverslag van Herhaalrecept op 4 maart 2026 met Pharmeon acceptatie zorgver... Pharmeon acceptatie zorgverlener Huisarts plain/text 67781-5
Regels
(P) LISINOPRIL TABLET 10MG / 10,00 ST / 1D1T; VAN 4-3-2026 TOT 14-3-2026
▼ CGM 4-3-2026 Contactverslag van Notitie/memo op 4 maart 2026 met Pharmeon acceptatie zorgverl... Pharmeon acceptatie zorgverlener Huisarts plain/text 67781-5
▼ CGM 4-3-2026 Contactverslag van Notitie/memo op 4 maart 2026 met Pharmeon acceptatie zorgverl... Pharmeon acceptatie zorgverlener Huisarts plain/text 67781-5
▼ CGM 4-3-2026 Contactverslag van Notitie/memo op 4 maart 2026 met Pharmeon acceptatie zorgverl... Pharmeon acceptatie zorgverlener Huisarts plain/text 67781-5
▼ CGM 26-2-2026 Contactverslag van Contact op 26 februari 2026 met Pharmeon acceptatie zorgverle... Pharmeon acceptatie zorgverlener Huisarts plain/text 67781-5
Chipsoft 20-8-2025 Ourmind .docx 394802001 application/vnd.openxmlformats-officedocument.wordprocessingml.document 51852-2
Chipsoft 20-8-2025 Ourmind 394802001 application/pdf 51852-2
Chipsoft 20-8-2025 Ourmind 394802001 application/pdf 51852-2
Chipsoft 20-8-2025 Ourmind 394802001 application/pdf 51852-2
Chipsoft 20-8-2025 Ourmind 394802001 application/pdf 51852-2
▼ Sanday 7-8-2025 Rughernia J van der Vecht Huisarts plain/text 67781-5
Regels
(E) HNP
(P) Nogmaals verwijzing Cesar
Chipsoft 4-8-2025 Blanco brief WZA 394802001 application/pdf 51852-2
Chipsoft 28-7-2025 Medisch beeldvormende techniek per onderzoek 394802001 application/pdf 68609-7
Epic-PZP 23-7-2025 Artsenbrief, Proactieve zorgplanning RPHM. Muskens, Oogarts application/pdf Artsenbrief
Chipsoft 21-7-2025 Poliklinische consultbrief (OK+Brief) UMCU 394802001 application/pdf 68609-7
Chipsoft 17-7-2025 Medisch beeldvormende techniek per onderzoek 394802001 application/pdf 51852-2
Chipsoft 5-6-2025 Blanco brief WZA 394802001 application/pdf 68609-7
Chipsoft 5-6-2025 Blanco brief 394802001 application/pdf 68609-7
Chipsoft 23-4-2025 Verwijsbrief 394802001 application/pdf 68609-7
Chipsoft 23-4-2025 Letter 394802001 application/pdf 51852-2
▼ CGM 11-3-2025 Contactverslag van Consult op 11 maart 2025 met Pharmeon acceptatie zorgverlener Pharmeon acceptatie zorgverlener Huisarts plain/text 67781-5
Chipsoft 18-12-2024 Radiologie 394802001 application/pdf 68609-7
Chipsoft 18-12-2024 Verwijsbrief 394802001 application/pdf 68609-7
Chipsoft 11-11-2024 Verwijsbrief 394802001 application/pdf 68609-7
Chipsoft 24-4-2024 Verwijsbrief 394802001 application/pdf 68609-7
Chipsoft 24-4-2024 Verwijsbrief 394802001 application/pdf 68609-7
Chipsoft 24-4-2024 Verwijsbrief 394802001 application/pdf 68609-7
Chipsoft 24-4-2024 Verwijsbrief 394802001 application/pdf 68609-7
Chipsoft 23-4-2024 Verwijsbrief 394802001 application/pdf 68609-7
▼ CGM 3-6-2023 Contactverslag van Herhaalrecept op 3 juni 2023 met Pharmeon acceptatie zorgverl... Pharmeon acceptatie zorgverlener Huisarts plain/text 67781-5
Regels
(P) HEPATITIS-A-VACCIN VAQTA JR WWSP 0,5ML (50E/ML) / 1,00 ST / GB
Chipsoft 22-8-2022 Letter 394802001 application/pdf 51852-2
Chipsoft 22-8-2022 Brief zorginstelling 394802001 application/pdf 68609-7
Chipsoft 12-5-2022 test 394802001 application/pdf 51852-2
Epic 15-12-2021 Patiëntenbrief, Brief (uit) G Boer KGA - Genetica application/pdf Patiëntenbrief
▼ CGM 15-11-2012 Contactverslag van Notitie/memo op 15 november 2012 met Pharmeon acceptatie zorg... Pharmeon acceptatie zorgverlener Huisarts plain/text 67781-5
▼ CGM 10-8-2012 Contactverslag van Notitie/memo op 10 augustus 2012 met Pharmeon acceptatie zorg... Pharmeon acceptatie zorgverlener Huisarts plain/text 67781-5
▼ CGM 20-4-2011 Contactverslag van Notitie/memo op 20 april 2011 met Pharmeon acceptatie zorgver... Pharmeon acceptatie zorgverlener Huisarts plain/text 67781-5
▼ CGM 20-4-2011 Contactverslag van Consult op 20 april 2011 met Pharmeon acceptatie zorgverlener Pharmeon acceptatie zorgverlener Huisarts plain/text 67781-5
Regels
(P) verwijzing ziekenhuis voor gips

Gegevensherkomst

Label FHIR Path Expression FHIR Type Zib element Toelichting of regels
DocumentReference
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 iif(exists(context.period.start), context.period.start, indexed) dateTime nvt Datum en tijd van het document. Indien niet aanwezig, dan datum en tijd van de indexering.
Beschrijving iif(exists(description), description, content.attachment.title.replace('.pdf',''))+iif(exists(context.encounter.display),', '+context.encounter.display,'') string nvt Tijdelijk voor Zorgplatform: gebruik content.attachment.title voor de beschrijving van documenten inclusief het strippen van de .pdf extensie
Auteur author.display string nvt Tijdelijk voor Zorgplatform: indien author.display is gevuld met een OID, dan wordt het veld gevuld met Auteur niet bekend
Specialisme iif(context.practiceSetting.text.startsWith('2.16.840.1.113883.'), context.practiceSetting.coding.code, context.practiceSetting.text) string nvt Tijdelijk voor Zorgplatform: indien context.practiceSetting.text is gevuld met een OID (startsWith('2.16.840.1.113883.)), dan wordt het veld gevuld met context.practiceSetting.coding.code (een SNOMED CT code)
CONTROL
(MimeType) content.attachment.contentType code nvt Alleen application/pdf tonen
(Type) iif(type.text.startsWith('2.16.840.1.113883.'), type.coding[0].code, type.text) string nvt
Composition
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 dateTime SOEPVerslagDatumTijd
Beschrijving title string nvt
Auteur author.display string Auteur
Specialisme 'Huisarts' string nvt
DETAILS
+Regels section.select('(' + code.coding.code + ') ' + text.`div`.replaceMatches('<[^>]*>', '')).join(' ') string SOEPRegel Tussen haakjes de SOEP-regel type, gevolgd door de tekst van de regel. De tekst wordt ontdaan van HTML tags.
CONTROL
(MimeType) 'plain/text' string nvt
(Type) type.coding[0].code string Auteur
Observation
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 effectiveDateTime dateTime nvt
Beschrijving extension('https://nuts.nl/fhir/StructureDefinition/nl-core-nursingreport/title').valueString string nvt
Auteur performer.display string nvt
Specialisme 'VVT' string nvt
DETAILS
+Verslag valueString string nvt
CONTROL
(MimeType) 'plain/text' string nvt
(Type) code.text string nvt

Requests

Er is geen request waarmee je de resources in 1 keer kan opvragen. Je moet hiervoor dus een request doen per resource.

  1. Zie DocumentReference en EncounterReport

  2. Opvragen (search) alle verpleegkundige rapportages (alleen NUTS gebasseerde bronnen)

    GET <ontsluiten-bronsysteem-base>/Observation?patient=<fhir_patient_id>&_profile=https://nuts.nl/fhir/StructureDefinition/nl-core-nursingreport&_sort=-date&_count=10

Usages:

  • This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.type This element is included in summaries. 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.
Bundle.Slices for entry This element is included in summaries. C 0..* BackboneElement Entry in the bundle - will have a resource, or information
Slice: Unordered, Open by type:resource
Constraints: bdl-8, bdl-5

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:DocumentReference This element is included in summaries. C 0..* BackboneElement DocumentReference
Constraints: bdl-8, bdl-5
Bundle.Slices for entry.entry:DocumentReference.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:DocumentReference.resource This element is included in summaries. 0..1 DocumentReference Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A reference to a document
Bundle.Slices for entry.entry:EncounterReport This element is included in summaries. C 0..* BackboneElement EncounterReport
Constraints: bdl-8, bdl-5
Bundle.Slices for entry.entry:EncounterReport.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:EncounterReport.resource This element is included in summaries. 0..1 EncounterReport Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A set of resources composed into a single coherent clinical statement with clinical attestation

doco 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:DocumentReference, Bundle.entry:EncounterReport 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:DocumentReference, Bundle.entry:EncounterReport 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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 0..* Bundle This is an abstract profile.
Contains a collection of resources
Bundle.Slices for entry 0..* BackboneElement Entry in the bundle - will have a resource, or information
Slice: Unordered, Open by type:resource
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:DocumentReference 0..* BackboneElement DocumentReference
Bundle.Slices for entry.entry:DocumentReference.resource 0..1 DocumentReference A reference to a document
Bundle.Slices for entry.entry:EncounterReport 0..* BackboneElement EncounterReport
Bundle.Slices for entry.entry:EncounterReport.resource 0..1 EncounterReport A set of resources composed into a single coherent clinical statement with clinical attestation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
Bundle.id This element is included in summaries. 0..1 id Logical id of this artifact
Bundle.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.language 0..1 code Language of the resource content
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
Bundle.identifier This element is included in summaries. 0..1 Identifier Persistent identifier for the bundle
Bundle.type This element is included in summaries. 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.
Bundle.total This element is included in summaries. C 0..1 unsignedInt If search, the total number of matches
Bundle.link This element is included in summaries. 0..* BackboneElement Links related to this Bundle
Bundle.link.id 0..1 string xml:id (or equivalent in JSON)
Bundle.link.extension 0..* Extension Additional Content defined by implementations
Bundle.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.link.relation This element is included in summaries. 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Bundle.link.url This element is included in summaries. 1..1 uri Reference details for the link
Bundle.Slices for entry This element is included in summaries. C 0..* BackboneElement Entry in the bundle - will have a resource, or information
Slice: Unordered, Open by type:resource
Constraints: bdl-8, bdl-5

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:All Slices.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:All Slices.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. 0..1 uri Absolute URL for resource (server address, or UUID/OID)
Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. 0..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:All Slices.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:All Slices.search.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:All Slices.search.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:All Slices.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:All Slices.search.mode This element is included in summaries. 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.
Bundle.Slices for entry.entry:All Slices.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:All Slices.request This element is included in summaries. C 0..1 BackboneElement Transaction Related Information
Bundle.Slices for entry.entry:All Slices.request.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:All Slices.request.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:All Slices.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:All Slices.request.method This element is included in summaries. 1..1 code GET | POST | PUT | DELETE
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
Bundle.Slices for entry.entry:All Slices.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:All Slices.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
Bundle.Slices for entry.entry:All Slices.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing update contention
Bundle.Slices for entry.entry:All Slices.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:All Slices.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:All Slices.response This element is included in summaries. C 0..1 BackboneElement Transaction Related Information
Bundle.Slices for entry.entry:All Slices.response.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:All Slices.response.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:All Slices.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:All Slices.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:All Slices.response.location This element is included in summaries. 0..1 uri The location, if the operation returns a location
Bundle.Slices for entry.entry:All Slices.response.etag This element is included in summaries. 0..1 string The etag for the resource (if relevant)
Bundle.Slices for entry.entry:All Slices.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:All Slices.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:DocumentReference This element is included in summaries. C 0..* BackboneElement DocumentReference
Constraints: bdl-8, bdl-5
Bundle.Slices for entry.entry:DocumentReference.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:DocumentReference.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:DocumentReference.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:DocumentReference.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:DocumentReference.fullUrl This element is included in summaries. 0..1 uri Absolute URL for resource (server address, or UUID/OID)
Bundle.Slices for entry.entry:DocumentReference.resource This element is included in summaries. 0..1 DocumentReference Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A reference to a document
Bundle.Slices for entry.entry:DocumentReference.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:DocumentReference.search.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:DocumentReference.search.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:DocumentReference.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:DocumentReference.search.mode This element is included in summaries. 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.
Bundle.Slices for entry.entry:DocumentReference.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:DocumentReference.request This element is included in summaries. C 0..1 BackboneElement Transaction Related Information
Bundle.Slices for entry.entry:DocumentReference.request.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:DocumentReference.request.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:DocumentReference.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:DocumentReference.request.method This element is included in summaries. 1..1 code GET | POST | PUT | DELETE
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
Bundle.Slices for entry.entry:DocumentReference.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:DocumentReference.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
Bundle.Slices for entry.entry:DocumentReference.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing update contention
Bundle.Slices for entry.entry:DocumentReference.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:DocumentReference.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:DocumentReference.response This element is included in summaries. C 0..1 BackboneElement Transaction Related Information
Bundle.Slices for entry.entry:DocumentReference.response.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:DocumentReference.response.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:DocumentReference.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:DocumentReference.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:DocumentReference.response.location This element is included in summaries. 0..1 uri The location, if the operation returns a location
Bundle.Slices for entry.entry:DocumentReference.response.etag This element is included in summaries. 0..1 string The etag for the resource (if relevant)
Bundle.Slices for entry.entry:DocumentReference.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:DocumentReference.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:EncounterReport This element is included in summaries. C 0..* BackboneElement EncounterReport
Constraints: bdl-8, bdl-5
Bundle.Slices for entry.entry:EncounterReport.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:EncounterReport.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:EncounterReport.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:EncounterReport.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:EncounterReport.fullUrl This element is included in summaries. 0..1 uri Absolute URL for resource (server address, or UUID/OID)
Bundle.Slices for entry.entry:EncounterReport.resource This element is included in summaries. 0..1 EncounterReport Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A set of resources composed into a single coherent clinical statement with clinical attestation
Bundle.Slices for entry.entry:EncounterReport.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:EncounterReport.search.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:EncounterReport.search.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:EncounterReport.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:EncounterReport.search.mode This element is included in summaries. 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.
Bundle.Slices for entry.entry:EncounterReport.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:EncounterReport.request This element is included in summaries. C 0..1 BackboneElement Transaction Related Information
Bundle.Slices for entry.entry:EncounterReport.request.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:EncounterReport.request.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:EncounterReport.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:EncounterReport.request.method This element is included in summaries. 1..1 code GET | POST | PUT | DELETE
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
Bundle.Slices for entry.entry:EncounterReport.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:EncounterReport.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
Bundle.Slices for entry.entry:EncounterReport.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing update contention
Bundle.Slices for entry.entry:EncounterReport.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:EncounterReport.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:EncounterReport.response This element is included in summaries. C 0..1 BackboneElement Transaction Related Information
Bundle.Slices for entry.entry:EncounterReport.response.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:EncounterReport.response.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:EncounterReport.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:EncounterReport.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:EncounterReport.response.location This element is included in summaries. 0..1 uri The location, if the operation returns a location
Bundle.Slices for entry.entry:EncounterReport.response.etag This element is included in summaries. 0..1 string The etag for the resource (if relevant)
Bundle.Slices for entry.entry:EncounterReport.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:EncounterReport.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.signature This element is included in summaries. 0..1 Signature Digital Signature

doco 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:DocumentReference.​search.mode Base required SearchEntryMode 📍3.0.2 FHIR Std.
Bundle.entry:DocumentReference.​request.method Base required HTTPVerb 📍3.0.2 FHIR Std.
Bundle.entry:EncounterReport.​search.mode Base required SearchEntryMode 📍3.0.2 FHIR Std.
Bundle.entry:EncounterReport.​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:DocumentReference, Bundle.entry:EncounterReport 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:DocumentReference, Bundle.entry:EncounterReport 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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.type This element is included in summaries. 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.
Bundle.Slices for entry This element is included in summaries. C 0..* BackboneElement Entry in the bundle - will have a resource, or information
Slice: Unordered, Open by type:resource
Constraints: bdl-8, bdl-5

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:DocumentReference This element is included in summaries. C 0..* BackboneElement DocumentReference
Constraints: bdl-8, bdl-5
Bundle.Slices for entry.entry:DocumentReference.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:DocumentReference.resource This element is included in summaries. 0..1 DocumentReference Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A reference to a document
Bundle.Slices for entry.entry:EncounterReport This element is included in summaries. C 0..* BackboneElement EncounterReport
Constraints: bdl-8, bdl-5
Bundle.Slices for entry.entry:EncounterReport.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:EncounterReport.resource This element is included in summaries. 0..1 EncounterReport Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A set of resources composed into a single coherent clinical statement with clinical attestation

doco 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:DocumentReference, Bundle.entry:EncounterReport 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:DocumentReference, Bundle.entry:EncounterReport 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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 0..* Bundle This is an abstract profile.
Contains a collection of resources
Bundle.Slices for entry 0..* BackboneElement Entry in the bundle - will have a resource, or information
Slice: Unordered, Open by type:resource
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:DocumentReference 0..* BackboneElement DocumentReference
Bundle.Slices for entry.entry:DocumentReference.resource 0..1 DocumentReference A reference to a document
Bundle.Slices for entry.entry:EncounterReport 0..* BackboneElement EncounterReport
Bundle.Slices for entry.entry:EncounterReport.resource 0..1 EncounterReport A set of resources composed into a single coherent clinical statement with clinical attestation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
Bundle.id This element is included in summaries. 0..1 id Logical id of this artifact
Bundle.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.language 0..1 code Language of the resource content
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
Bundle.identifier This element is included in summaries. 0..1 Identifier Persistent identifier for the bundle
Bundle.type This element is included in summaries. 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.
Bundle.total This element is included in summaries. C 0..1 unsignedInt If search, the total number of matches
Bundle.link This element is included in summaries. 0..* BackboneElement Links related to this Bundle
Bundle.link.id 0..1 string xml:id (or equivalent in JSON)
Bundle.link.extension 0..* Extension Additional Content defined by implementations
Bundle.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.link.relation This element is included in summaries. 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Bundle.link.url This element is included in summaries. 1..1 uri Reference details for the link
Bundle.Slices for entry This element is included in summaries. C 0..* BackboneElement Entry in the bundle - will have a resource, or information
Slice: Unordered, Open by type:resource
Constraints: bdl-8, bdl-5

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:All Slices.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:All Slices.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. 0..1 uri Absolute URL for resource (server address, or UUID/OID)
Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. 0..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:All Slices.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:All Slices.search.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:All Slices.search.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:All Slices.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:All Slices.search.mode This element is included in summaries. 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.
Bundle.Slices for entry.entry:All Slices.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:All Slices.request This element is included in summaries. C 0..1 BackboneElement Transaction Related Information
Bundle.Slices for entry.entry:All Slices.request.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:All Slices.request.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:All Slices.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:All Slices.request.method This element is included in summaries. 1..1 code GET | POST | PUT | DELETE
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
Bundle.Slices for entry.entry:All Slices.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:All Slices.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
Bundle.Slices for entry.entry:All Slices.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing update contention
Bundle.Slices for entry.entry:All Slices.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:All Slices.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:All Slices.response This element is included in summaries. C 0..1 BackboneElement Transaction Related Information
Bundle.Slices for entry.entry:All Slices.response.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:All Slices.response.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:All Slices.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:All Slices.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:All Slices.response.location This element is included in summaries. 0..1 uri The location, if the operation returns a location
Bundle.Slices for entry.entry:All Slices.response.etag This element is included in summaries. 0..1 string The etag for the resource (if relevant)
Bundle.Slices for entry.entry:All Slices.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:All Slices.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:DocumentReference This element is included in summaries. C 0..* BackboneElement DocumentReference
Constraints: bdl-8, bdl-5
Bundle.Slices for entry.entry:DocumentReference.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:DocumentReference.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:DocumentReference.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:DocumentReference.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:DocumentReference.fullUrl This element is included in summaries. 0..1 uri Absolute URL for resource (server address, or UUID/OID)
Bundle.Slices for entry.entry:DocumentReference.resource This element is included in summaries. 0..1 DocumentReference Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A reference to a document
Bundle.Slices for entry.entry:DocumentReference.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:DocumentReference.search.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:DocumentReference.search.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:DocumentReference.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:DocumentReference.search.mode This element is included in summaries. 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.
Bundle.Slices for entry.entry:DocumentReference.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:DocumentReference.request This element is included in summaries. C 0..1 BackboneElement Transaction Related Information
Bundle.Slices for entry.entry:DocumentReference.request.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:DocumentReference.request.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:DocumentReference.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:DocumentReference.request.method This element is included in summaries. 1..1 code GET | POST | PUT | DELETE
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
Bundle.Slices for entry.entry:DocumentReference.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:DocumentReference.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
Bundle.Slices for entry.entry:DocumentReference.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing update contention
Bundle.Slices for entry.entry:DocumentReference.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:DocumentReference.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:DocumentReference.response This element is included in summaries. C 0..1 BackboneElement Transaction Related Information
Bundle.Slices for entry.entry:DocumentReference.response.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:DocumentReference.response.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:DocumentReference.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:DocumentReference.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:DocumentReference.response.location This element is included in summaries. 0..1 uri The location, if the operation returns a location
Bundle.Slices for entry.entry:DocumentReference.response.etag This element is included in summaries. 0..1 string The etag for the resource (if relevant)
Bundle.Slices for entry.entry:DocumentReference.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:DocumentReference.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:EncounterReport This element is included in summaries. C 0..* BackboneElement EncounterReport
Constraints: bdl-8, bdl-5
Bundle.Slices for entry.entry:EncounterReport.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:EncounterReport.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:EncounterReport.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:EncounterReport.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:EncounterReport.fullUrl This element is included in summaries. 0..1 uri Absolute URL for resource (server address, or UUID/OID)
Bundle.Slices for entry.entry:EncounterReport.resource This element is included in summaries. 0..1 EncounterReport Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A set of resources composed into a single coherent clinical statement with clinical attestation
Bundle.Slices for entry.entry:EncounterReport.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:EncounterReport.search.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:EncounterReport.search.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:EncounterReport.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:EncounterReport.search.mode This element is included in summaries. 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.
Bundle.Slices for entry.entry:EncounterReport.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:EncounterReport.request This element is included in summaries. C 0..1 BackboneElement Transaction Related Information
Bundle.Slices for entry.entry:EncounterReport.request.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:EncounterReport.request.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:EncounterReport.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:EncounterReport.request.method This element is included in summaries. 1..1 code GET | POST | PUT | DELETE
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).
Bundle.Slices for entry.entry:EncounterReport.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:EncounterReport.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
Bundle.Slices for entry.entry:EncounterReport.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing update contention
Bundle.Slices for entry.entry:EncounterReport.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:EncounterReport.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:EncounterReport.response This element is included in summaries. C 0..1 BackboneElement Transaction Related Information
Bundle.Slices for entry.entry:EncounterReport.response.id 0..1 string xml:id (or equivalent in JSON)
Bundle.Slices for entry.entry:EncounterReport.response.extension 0..* Extension Additional Content defined by implementations
Bundle.Slices for entry.entry:EncounterReport.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:EncounterReport.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:EncounterReport.response.location This element is included in summaries. 0..1 uri The location, if the operation returns a location
Bundle.Slices for entry.entry:EncounterReport.response.etag This element is included in summaries. 0..1 string The etag for the resource (if relevant)
Bundle.Slices for entry.entry:EncounterReport.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:EncounterReport.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.signature This element is included in summaries. 0..1 Signature Digital Signature

doco 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:DocumentReference.​search.mode Base required SearchEntryMode 📍3.0.2 FHIR Std.
Bundle.entry:DocumentReference.​request.method Base required HTTPVerb 📍3.0.2 FHIR Std.
Bundle.entry:EncounterReport.​search.mode Base required SearchEntryMode 📍3.0.2 FHIR Std.
Bundle.entry:EncounterReport.​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:DocumentReference, Bundle.entry:EncounterReport 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:DocumentReference, Bundle.entry:EncounterReport 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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron