Belgian MyCareNet Profiles
2.0.0 - STU
Belgian MyCareNet Profiles
2.0.0 - STU
This page is part of the HL7 Belgium FHIR Implementation Guide - MyCareNet profiles (v2.0.0: Trial Use) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Official URL: https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-eagreementconsult | Version: 2.0.0 | |||
| Active as of 2023-04-27 | Computable Name: BeMyCareNetEagreementconsult | |||
Profile for the consulting of eAgreement in the MyCareNet flows.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle | 0..* | Bundle | Contains a collection of resources | |
  id | S | 1..1 | id | Logical id of this artifact |
 meta | S | 1..1 | Meta | Metadata about the resource |
  profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| type | S | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection |
| timestamp | S | 1..1 | instant | When the bundle was assembled |
  Slices for entry | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource | |
   entry:messageHeader | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
  fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
 resource | 1..1 | BeMyCareNetMessageHeader | A resource that describes a message that is exchanged between systems | |
| entry:practitioner | S | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource | 1..1 | BePractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| entry:practitionerRole | S | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource | 1..1 | BePractitionerRole | Roles/organizations the practitioner is associated with | |
| entry:organization | S | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource | 1..1 | BeOrganization | A grouping of people or organizations with a common purpose | |
| entry:patient | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource | 1..1 | BePatient | Information about an individual or animal receiving health care services | |
 entry:parameters | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource | 1..1 | Parameters | A resource in the bundle | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | C | 0..* | Bundle | Contains a collection of resources |
 id | SΣ | 1..1 | id | Logical id of this artifact |
 meta | SΣ | 1..1 | Meta | Metadata about the resource |
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| type | SΣ | 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 is intended to be used. |
| timestamp | SΣ | 1..1 | instant | When the bundle was assembled |
| Slices for entry | ΣC | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| entry:All Slices | Content/Rules for all slices | |||
  modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entry:messageHeader | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | 1..1 | BeMyCareNetMessageHeader | A resource that describes a message that is exchanged between systems | |
| entry:practitioner | SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | 1..1 | BePractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| entry:practitionerRole | SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | 1..1 | BePractitionerRole | Roles/organizations the practitioner is associated with | |
| entry:organization | SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | C | 1..1 | BeOrganization | A grouping of people or organizations with a common purpose |
| entry:patient | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | 1..1 | BePatient | Information about an individual or animal receiving health care services | |
| entry:parameters | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | Σ | 1..1 | Parameters | A resource in the bundle |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Bundle.type | required | BundleType |
| Id | Grade | Path(s) | Details | Requirements |
| 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 mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) | |
| bdl-5 | error | Bundle.entry, Bundle.entry:messageHeader, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:organization, Bundle.entry:patient, Bundle.entry:parameters | 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 (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
| bdl-8 | error | Bundle.entry, Bundle.entry:messageHeader, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:organization, Bundle.entry:patient, Bundle.entry:parameters | 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()) | |
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| dom-2 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Bundle.entry:organization.resource | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle | C | 0..* | Bundle | Contains a collection of resources | ||||
| id | SΣ | 1..1 | id | Logical id of this artifact | ||||
| meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
| type | SΣ | 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 is intended to be used. | ||||
| timestamp | SΣ | 1..1 | instant | When the bundle was assembled | ||||
| total | ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link | Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
| url | Σ | 1..1 | uri | Reference details for the link | ||||
| Slices for entry | ΣC | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| entry:All Slices | Content/Rules for all slices | |||||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | Σ | 0..1 | Resource | A resource in the bundle | ||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| entry:messageHeader | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | 1..1 | BeMyCareNetMessageHeader | A resource that describes a message that is exchanged between systems | |||||
 search | ΣC | 0..1 | BackboneElement | Search related information | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
 response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| entry:practitioner | SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | 1..1 | BePractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| entry:practitionerRole | SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | 1..1 | BePractitionerRole | Roles/organizations the practitioner is associated with | |||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| entry:organization | SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | C | 1..1 | BeOrganization | A grouping of people or organizations with a common purpose | ||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| entry:patient | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | 1..1 | BePatient | Information about an individual or animal receiving health care services | |||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| entry:parameters | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | Σ | 1..1 | Parameters | A resource in the bundle | ||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| signature | ΣTU | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Bundle.meta.security | extensible | All Security Labels | ||||
| Bundle.meta.tag | example | CommonTags | ||||
| Bundle.language | preferred | CommonLanguages
| ||||
| Bundle.type | required | BundleType | ||||
| Bundle.entry.search.mode | required | SearchEntryMode | ||||
| Bundle.entry.request.method | required | HTTPVerb | ||||
| Bundle.entry:messageHeader.search.mode | required | SearchEntryMode | ||||
| Bundle.entry:messageHeader.request.method | required | HTTPVerb | ||||
| Bundle.entry:practitioner.search.mode | required | SearchEntryMode | ||||
| Bundle.entry:practitioner.request.method | required | HTTPVerb | ||||
| Bundle.entry:practitionerRole.search.mode | required | SearchEntryMode | ||||
| Bundle.entry:practitionerRole.request.method | required | HTTPVerb | ||||
| Bundle.entry:organization.search.mode | required | SearchEntryMode | ||||
| Bundle.entry:organization.request.method | required | HTTPVerb | ||||
| Bundle.entry:patient.search.mode | required | SearchEntryMode | ||||
| Bundle.entry:patient.request.method | required | HTTPVerb | ||||
| Bundle.entry:parameters.search.mode | required | SearchEntryMode | ||||
| Bundle.entry:parameters.request.method | required | HTTPVerb |
| Id | Grade | Path(s) | Details | Requirements |
| bdl-5 | error | Bundle.entry, Bundle.entry:messageHeader, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:organization, Bundle.entry:patient, Bundle.entry:parameters | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-8 | error | Bundle.entry, Bundle.entry:messageHeader, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:organization, Bundle.entry:patient, Bundle.entry:parameters | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
| dom-2 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Bundle.entry:organization.resource | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
This structure is derived from Bundle
Summary
Mandatory: 13 elements (6 nested mandatory elements)
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | 0..* | Bundle | Contains a collection of resources | |
| id | S | 1..1 | id | Logical id of this artifact |
| meta | S | 1..1 | Meta | Metadata about the resource |
| profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| type | S | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection |
| timestamp | S | 1..1 | instant | When the bundle was assembled |
| Slices for entry | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource | |
| entry:messageHeader | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource | 1..1 | BeMyCareNetMessageHeader | A resource that describes a message that is exchanged between systems | |
| entry:practitioner | S | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource | 1..1 | BePractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| entry:practitionerRole | S | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource | 1..1 | BePractitionerRole | Roles/organizations the practitioner is associated with | |
| entry:organization | S | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource | 1..1 | BeOrganization | A grouping of people or organizations with a common purpose | |
| entry:patient | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource | 1..1 | BePatient | Information about an individual or animal receiving health care services | |
| entry:parameters | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource | 1..1 | Parameters | A resource in the bundle | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | C | 0..* | Bundle | Contains a collection of resources |
| id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | SΣ | 1..1 | Meta | Metadata about the resource |
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| type | SΣ | 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 is intended to be used. |
| timestamp | SΣ | 1..1 | instant | When the bundle was assembled |
| Slices for entry | ΣC | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| entry:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entry:messageHeader | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | 1..1 | BeMyCareNetMessageHeader | A resource that describes a message that is exchanged between systems | |
| entry:practitioner | SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | 1..1 | BePractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| entry:practitionerRole | SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | 1..1 | BePractitionerRole | Roles/organizations the practitioner is associated with | |
| entry:organization | SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | C | 1..1 | BeOrganization | A grouping of people or organizations with a common purpose |
| entry:patient | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | 1..1 | BePatient | Information about an individual or animal receiving health care services | |
| entry:parameters | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | Σ | 1..1 | Parameters | A resource in the bundle |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Bundle.type | required | BundleType |
| Id | Grade | Path(s) | Details | Requirements |
| 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 mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) | |
| bdl-5 | error | Bundle.entry, Bundle.entry:messageHeader, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:organization, Bundle.entry:patient, Bundle.entry:parameters | 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 (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
| bdl-8 | error | Bundle.entry, Bundle.entry:messageHeader, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:organization, Bundle.entry:patient, Bundle.entry:parameters | 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()) | |
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| dom-2 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Bundle.entry:organization.resource | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle | C | 0..* | Bundle | Contains a collection of resources | ||||
| id | SΣ | 1..1 | id | Logical id of this artifact | ||||
| meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
| type | SΣ | 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 is intended to be used. | ||||
| timestamp | SΣ | 1..1 | instant | When the bundle was assembled | ||||
| total | ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link | Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
| url | Σ | 1..1 | uri | Reference details for the link | ||||
| Slices for entry | ΣC | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| entry:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | Σ | 0..1 | Resource | A resource in the bundle | ||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| entry:messageHeader | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | 1..1 | BeMyCareNetMessageHeader | A resource that describes a message that is exchanged between systems | |||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| entry:practitioner | SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | 1..1 | BePractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| entry:practitionerRole | SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | 1..1 | BePractitionerRole | Roles/organizations the practitioner is associated with | |||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| entry:organization | SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | C | 1..1 | BeOrganization | A grouping of people or organizations with a common purpose | ||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| entry:patient | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | 1..1 | BePatient | Information about an individual or animal receiving health care services | |||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| entry:parameters | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | Σ | 1..1 | Parameters | A resource in the bundle | ||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| signature | ΣTU | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Bundle.meta.security | extensible | All Security Labels | ||||
| Bundle.meta.tag | example | CommonTags | ||||
| Bundle.language | preferred | CommonLanguages
| ||||
| Bundle.type | required | BundleType | ||||
| Bundle.entry.search.mode | required | SearchEntryMode | ||||
| Bundle.entry.request.method | required | HTTPVerb | ||||
| Bundle.entry:messageHeader.search.mode | required | SearchEntryMode | ||||
| Bundle.entry:messageHeader.request.method | required | HTTPVerb | ||||
| Bundle.entry:practitioner.search.mode | required | SearchEntryMode | ||||
| Bundle.entry:practitioner.request.method | required | HTTPVerb | ||||
| Bundle.entry:practitionerRole.search.mode | required | SearchEntryMode | ||||
| Bundle.entry:practitionerRole.request.method | required | HTTPVerb | ||||
| Bundle.entry:organization.search.mode | required | SearchEntryMode | ||||
| Bundle.entry:organization.request.method | required | HTTPVerb | ||||
| Bundle.entry:patient.search.mode | required | SearchEntryMode | ||||
| Bundle.entry:patient.request.method | required | HTTPVerb | ||||
| Bundle.entry:parameters.search.mode | required | SearchEntryMode | ||||
| Bundle.entry:parameters.request.method | required | HTTPVerb |
| Id | Grade | Path(s) | Details | Requirements |
| bdl-5 | error | Bundle.entry, Bundle.entry:messageHeader, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:organization, Bundle.entry:patient, Bundle.entry:parameters | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-8 | error | Bundle.entry, Bundle.entry:messageHeader, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:organization, Bundle.entry:patient, Bundle.entry:parameters | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
| dom-2 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Bundle.entry:messageHeader.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerRole.resource, Bundle.entry:organization.resource, Bundle.entry:patient.resource | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Bundle.entry:organization.resource | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
This structure is derived from Bundle
Summary
Mandatory: 13 elements (6 nested mandatory elements)
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ eHealth Platform. Package hl7.fhir.be.mycarenet#2.0.0 based on FHIR 4.0.1. Generated 2023-04-27
Links: Table of Contents |
QA Report
