RIVO-Noord Zorgviewer Implementation Guide
1.24.0 - CI build
RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.24.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/Correspondentie | Version: 1.24.0 | |||
| Active as of 2026-04-07 | Computable Name: Correspondentie | |||
Correspondentie abstracte samenstelling voor het documenteren van de combinatie van DocumentReference en Composition (SOEP Verslagen).
Dit Profiel is het resultaat van de vergelijking tussen de zib2017 FHIR Profiel en de implementaties in Epic, Chipsoft, Topicus en Nexus. De elementen die in ieder geval in alle output beschikbaar zullen zijn. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.
ViewDefinition voor Correspondentie
Correspondentie en SOEP verslagen
| >< | Bron | Datum | Beschrijving | Auteur | Specialisme | (MimeType) | (Type) |
|---|---|---|---|---|---|---|---|
| + | CGM | 3-3-2026 | Tipp: Test zorgviewer - Verwijsbrief, Notitie/memo op 4 maart 2026 met Pharmeon ... | Pharmeon acceptatie zorgverlener | application/pdf | Verwijsbrief | |
| + | Chipsoft | 19-8-2025 | Ourmind .docx | 394802001 | application/vnd.openxmlformats-officedocument.wordprocessingml.document | 51852-2 | |
| + | Chipsoft | 19-8-2025 | Ourmind | 394802001 | application/pdf | 51852-2 | |
| + | Chipsoft | 19-8-2025 | Ourmind | 394802001 | application/pdf | 51852-2 | |
| + | Chipsoft | 19-8-2025 | Ourmind | 394802001 | application/pdf | 51852-2 | |
| + | Chipsoft | 19-8-2025 | Ourmind | 394802001 | application/pdf | 51852-2 | |
| + | 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 | 20-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 | 4-6-2025 | Blanco brief WZA | 394802001 | application/pdf | 68609-7 | |
| + | Chipsoft | 4-6-2025 | Blanco brief | 394802001 | application/pdf | 68609-7 | |
| + | Chipsoft | 22-4-2025 | Verwijsbrief | 394802001 | application/pdf | 68609-7 | |
| + | Chipsoft | 22-4-2025 | Letter | 394802001 | application/pdf | 51852-2 | |
| + | Chipsoft | 18-12-2024 | Radiologie | 394802001 | application/pdf | 68609-7 | |
| + | Chipsoft | 18-12-2024 | Verwijsbrief | 394802001 | application/pdf | 68609-7 | |
| + | Chipsoft | 10-11-2024 | Verwijsbrief | 394802001 | application/pdf | 68609-7 | |
| + | Chipsoft | 23-4-2024 | Verwijsbrief | 394802001 | application/pdf | 68609-7 | |
| + | Chipsoft | 23-4-2024 | Verwijsbrief | 394802001 | application/pdf | 68609-7 | |
| + | Chipsoft | 23-4-2024 | Verwijsbrief | 394802001 | application/pdf | 68609-7 | |
| + | Chipsoft | 23-4-2024 | Verwijsbrief | 394802001 | application/pdf | 68609-7 | |
| + | Chipsoft | 22-4-2024 | Verwijsbrief | 394802001 | application/pdf | 68609-7 | |
| + | Chipsoft | 21-8-2022 | Letter | 394802001 | application/pdf | 51852-2 | |
| + | Chipsoft | 21-8-2022 | Brief zorginstelling | 394802001 | application/pdf | 68609-7 | |
| + | Chipsoft | 11-5-2022 | test | 394802001 | application/pdf | 51852-2 | |
| + | Epic | 15-12-2021 | Patiëntenbrief, Brief (uit) | G Boer | KGA - Genetica | application/pdf | Patiëntenbrief |
| >< | Bron | Datum | Beschrijving | Auteur | Specialisme | (MimeType) | (Type) |
| + | CGM | 4-3-2026 | Contactverslag van Consult op 4 maart 2026 met Pharmeon acceptatie zorgverlener | Pharmeon acceptatie zorgverlener | Huisarts | 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 | 67781-5 | |
| + | CGM | 4-3-2026 | Contactverslag van Herhaalrecept op 4 maart 2026 met Pharmeon acceptatie zorgver... | Pharmeon acceptatie zorgverlener | Huisarts | 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 | 67781-5 | |
| + | CGM | 4-3-2026 | Contactverslag van Notitie/memo op 4 maart 2026 met Pharmeon acceptatie zorgverl... | Pharmeon acceptatie zorgverlener | Huisarts | 67781-5 | |
| + | CGM | 4-3-2026 | Contactverslag van Notitie/memo op 4 maart 2026 met Pharmeon acceptatie zorgverl... | Pharmeon acceptatie zorgverlener | Huisarts | 67781-5 | |
| + | CGM | 26-2-2026 | Contactverslag van Contact op 26 februari 2026 met Pharmeon acceptatie zorgverle... | Pharmeon acceptatie zorgverlener | Huisarts | 67781-5 | |
| + | Sanday | 6-8-2025 | Rughernia | J van der Vecht | Huisarts | 67781-5 | |
|
Regels (E) HNP (P) Nogmaals verwijzing Cesar | |||||||
| + | CGM | 11-3-2025 | Contactverslag van Consult op 11 maart 2025 met Pharmeon acceptatie zorgverlener | Pharmeon acceptatie zorgverlener | Huisarts | 67781-5 | |
| + | CGM | 3-6-2023 | Contactverslag van Herhaalrecept op 3 juni 2023 met Pharmeon acceptatie zorgverl... | Pharmeon acceptatie zorgverlener | Huisarts | 67781-5 | |
|
Regels (P) HEPATITIS-A-VACCIN VAQTA JR WWSP 0,5ML (50E/ML) / 1,00 ST / GB | |||||||
| + | CGM | 15-11-2012 | Contactverslag van Notitie/memo op 15 november 2012 met Pharmeon acceptatie zorg... | Pharmeon acceptatie zorgverlener | Huisarts | 67781-5 | |
| + | CGM | 10-8-2012 | Contactverslag van Notitie/memo op 10 augustus 2012 met Pharmeon acceptatie zorg... | Pharmeon acceptatie zorgverlener | Huisarts | 67781-5 | |
| + | CGM | 20-4-2011 | Contactverslag van Notitie/memo op 20 april 2011 met Pharmeon acceptatie zorgver... | Pharmeon acceptatie zorgverlener | Huisarts | 67781-5 | |
| + | CGM | 20-4-2011 | Contactverslag van Consult op 20 april 2011 met Pharmeon acceptatie zorgverlener | Pharmeon acceptatie zorgverlener | Huisarts | 67781-5 | |
|
Regels (P) verwijzing ziekenhuis voor gips | |||||||
| Kolom 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 | N.B. tijd is GMT, dus omzetten naar CET. |
| 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) |
| MARKERING | ||||
| (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' and type.coding.code='67781-5 | ||||
| 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 | |
| UITKLAPVELD | ||||
| +Regels | section.select('(' + code.coding.code + ') ' + text.`div`.replaceMatches('<[^>]*>', '')).join(' ') | string |
SOEPRegel | |
| MARKERING | ||||
| (MimeType) | '' | string |
nvt | |
| (Type) | type.coding[0].code | string |
Auteur | |
Er is geen request waarmee je beide resources in 1 keer kan opvragen. Je moet hiervoor dus een request doen per resource.
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 1.23.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle | This is an abstract profile. Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-1, bdl-2 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Σ | 1..1 | code | searchset Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. Fixed Value: searchset |
![]() ![]() |
ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource Constraints: bdl-8, bdl-5 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | DocumentReference Constraints: bdl-8, bdl-5 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Absolute URL for resource (server address, or UUID/OID) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | DocumentReference | A reference to a document |
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | EncounterReport Constraints: bdl-8, bdl-5 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Absolute URL for resource (server address, or UUID/OID) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | EncounterReport | A set of resources composed into a single coherent clinical statement with clinical attestation |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request only for some types of bundles |
entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
|
| bdl-4 | error | Bundle | entry.response only for some types of bundles |
entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
|
| bdl-5 | error | Bundle.entry, Bundle.entry: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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Bundle | This is an abstract profile. Contains a collection of resources | |
![]() ![]() |
1..1 | code | searchset Fixed Value: searchset | |
![]() ![]() |
0..* | BackboneElement | Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource | |
![]() ![]() ![]() |
0..* | BackboneElement | DocumentReference | |
![]() ![]() ![]() ![]() |
1..1 | uri | Absolute URL for resource (server address, or UUID/OID) | |
![]() ![]() ![]() ![]() |
1..1 | DocumentReference | A reference to a document | |
![]() ![]() ![]() |
0..* | BackboneElement | EncounterReport | |
![]() ![]() ![]() ![]() |
1..1 | uri | Absolute URL for resource (server address, or UUID/OID) | |
![]() ![]() ![]() ![]() |
1..1 | EncounterReport | A set of resources composed into a single coherent clinical statement with clinical attestation | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Bundle | This is an abstract profile. Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-1, bdl-2 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
![]() ![]() |
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() |
Σ | 1..1 | code | searchset Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. Fixed Value: searchset | ||||
![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]() |
ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource Constraints: bdl-8, bdl-5 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Absolute URL for resource (server address, or UUID/OID) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location, if the operation returns a location | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | DocumentReference Constraints: bdl-8, bdl-5 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Absolute URL for resource (server address, or UUID/OID) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | DocumentReference | A reference to a document | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location, if the operation returns a location | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | EncounterReport Constraints: bdl-8, bdl-5 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Absolute URL for resource (server address, or UUID/OID) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | EncounterReport | A set of resources composed into a single coherent clinical statement with clinical attestation | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location, if the operation returns a location | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() |
Σ | 0..1 | Signature | Digital Signature | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | extensible | Common Languages | 📍3.0.2 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍3.0.2 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍3.0.2 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍3.0.2 | FHIR Std. |
| Bundle.entry: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. |
| 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
Mandatory: 0 element(4 nested mandatory elements)
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle | This is an abstract profile. Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-1, bdl-2 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Σ | 1..1 | code | searchset Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. Fixed Value: searchset |
![]() ![]() |
ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource Constraints: bdl-8, bdl-5 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | DocumentReference Constraints: bdl-8, bdl-5 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Absolute URL for resource (server address, or UUID/OID) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | DocumentReference | A reference to a document |
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | EncounterReport Constraints: bdl-8, bdl-5 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Absolute URL for resource (server address, or UUID/OID) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | EncounterReport | A set of resources composed into a single coherent clinical statement with clinical attestation |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request only for some types of bundles |
entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
|
| bdl-4 | error | Bundle | entry.response only for some types of bundles |
entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
|
| bdl-5 | error | Bundle.entry, Bundle.entry: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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Bundle | This is an abstract profile. Contains a collection of resources | |
![]() ![]() |
1..1 | code | searchset Fixed Value: searchset | |
![]() ![]() |
0..* | BackboneElement | Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource | |
![]() ![]() ![]() |
0..* | BackboneElement | DocumentReference | |
![]() ![]() ![]() ![]() |
1..1 | uri | Absolute URL for resource (server address, or UUID/OID) | |
![]() ![]() ![]() ![]() |
1..1 | DocumentReference | A reference to a document | |
![]() ![]() ![]() |
0..* | BackboneElement | EncounterReport | |
![]() ![]() ![]() ![]() |
1..1 | uri | Absolute URL for resource (server address, or UUID/OID) | |
![]() ![]() ![]() ![]() |
1..1 | EncounterReport | A set of resources composed into a single coherent clinical statement with clinical attestation | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Bundle | This is an abstract profile. Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-1, bdl-2 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
![]() ![]() |
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() |
Σ | 1..1 | code | searchset Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. Fixed Value: searchset | ||||
![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]() |
ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource, or information Slice: Unordered, Open by type:resource Constraints: bdl-8, bdl-5 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Absolute URL for resource (server address, or UUID/OID) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location, if the operation returns a location | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | DocumentReference Constraints: bdl-8, bdl-5 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Absolute URL for resource (server address, or UUID/OID) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | DocumentReference | A reference to a document | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location, if the operation returns a location | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | EncounterReport Constraints: bdl-8, bdl-5 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Absolute URL for resource (server address, or UUID/OID) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | EncounterReport | A set of resources composed into a single coherent clinical statement with clinical attestation | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Transaction Related Information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location, if the operation returns a location | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() |
Σ | 0..1 | Signature | Digital Signature | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | extensible | Common Languages | 📍3.0.2 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍3.0.2 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍3.0.2 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍3.0.2 | FHIR Std. |
| Bundle.entry: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. |
| 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
Mandatory: 0 element(4 nested mandatory elements)
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron