IHE Pharmacy Medication Record
0.1.0 - ci-build
IHE Pharmacy Medication Record, published by Integrating the Healthcare Enterprise (IHE). This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/IHE/pharm-medo/ and changes regularly. See the Directory of published versions
Official URL: http://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/MedRecord | Version: 0.1.0 | |||
Active as of 2023-03-27 | Computable Name: MedRecord | |||
Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property |
The profile for Medication Record
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 | |
identifier | S | 0..1 | Identifier | Persistent identifier for the bundle |
type | 1..1 | code | document Fixed Value: document | |
total | 0..0 | |||
link | 0..0 | |||
Slices for entry | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource | |
entry:Composition | 1..1 | BackboneElement | Composition | |
resource | S | 1..1 | MedRecordComposition | A set of resources composed into a single coherent clinical statement with clinical attestation |
entry:Patient | 1..1 | BackboneElement | Patient for whom the record is concerned | |
resource | S | 1..1 | Patient | A resource in the bundle |
entry:MedRecordTreatment | 0..* | BackboneElement | Treatments associated with the patient | |
resource | S | 1..1 | MedRecordTreatment | Healthcare plan for patient or group |
entry:MedRecordTreatmentLine | 0..* | BackboneElement | Treatment lines associated with the patient | |
resource | S | 1..1 | MedRecordTreatmentLine | Record of medication being taken by a patient |
entry:MedRecordMedicationSummaryView | 0..* | BackboneElement | Medication summaries associated with the patient | |
resource | S | 1..1 | MedRecordTreatmentLine | Record of medication being taken by a patient |
entry:MedRecordOrder | 0..* | BackboneElement | Medication summaries associated with the patient | |
resource | S | 1..1 | MedRecordOrder | Ordering of medication for patient or group |
entry:MedRecordDispense | 0..* | BackboneElement | Medication summaries associated with the patient | |
resource | S | 1..1 | MedRecordDispense | Dispensing a medication to a named patient |
entry:MedRecordAdministration | 0..* | BackboneElement | Medication summaries associated with the patient | |
resource | S | 1..1 | MedRecordAdministration | Administration of medication to a patient |
entry:MedRecordMedicationScheduledAdministration | 0..* | BackboneElement | Medication summaries associated with the patient | |
resource | S | 1..1 | MedRecordMedicationScheduledAdministration | Ordering of medication for patient or group |
entry:MedRecordUsage | 0..* | BackboneElement | Medication summaries associated with the patient | |
resource | S | 1..1 | MedRecordUsage | Record of medication being taken by a patient |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | C | 0..* | Bundle | Contains a collection of resources |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
identifier | SΣC | 0..1 | Identifier | Persistent identifier for the bundle |
type | ΣC | 1..1 | code | document Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document |
Slices for entry | ΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile: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 |
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | ΣC | 0..1 | Resource | A resource in the bundle |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:Composition | ΣC | 1..1 | BackboneElement | Composition 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordComposition | A set of resources composed into a single coherent clinical statement with clinical attestation |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:Patient | ΣC | 1..1 | BackboneElement | Patient for whom the record is concerned 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | SΣC | 1..1 | Patient | A resource in the bundle |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordTreatment | ΣC | 0..* | BackboneElement | Treatments associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordTreatment | Healthcare plan for patient or group |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordTreatmentLine | ΣC | 0..* | BackboneElement | Treatment lines associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordTreatmentLine | Record of medication being taken by a patient |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordMedicationSummaryView | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordTreatmentLine | Record of medication being taken by a patient |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordOrder | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordOrder | Ordering of medication for patient or group |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordDispense | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | SC | 1..1 | MedRecordDispense | Dispensing a medication to a named patient |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordAdministration | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordAdministration | Administration of medication to a patient |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordMedicationScheduledAdministration | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordMedicationScheduledAdministration | Ordering of medication for patient or group |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordUsage | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordUsage | Record of medication being taken by a patient |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
issues | ΣCTU | 0..1 | OperationOutcome | Issues with the Bundle |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Bundle.type | required | Fixed Value: document |
Bundle.link.relation | required | LinkRelationTypes |
Bundle.entry.request.method | required | HTTPVerb |
Bundle.entry:Composition.request.method | required | HTTPVerb |
Bundle.entry:Patient.request.method | required | HTTPVerb |
Bundle.entry:MedRecordTreatment.request.method | required | HTTPVerb |
Bundle.entry:MedRecordTreatmentLine.request.method | required | HTTPVerb |
Bundle.entry:MedRecordMedicationSummaryView.request.method | required | HTTPVerb |
Bundle.entry:MedRecordOrder.request.method | required | HTTPVerb |
Bundle.entry:MedRecordDispense.request.method | required | HTTPVerb |
Bundle.entry:MedRecordAdministration.request.method | required | HTTPVerb |
Bundle.entry:MedRecordMedicationScheduledAdministration.request.method | required | HTTPVerb |
Bundle.entry:MedRecordUsage.request.method | required | HTTPVerb |
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 : (type = 'searchset') or entry.search.empty() | |
bdl-5 | error | Bundle.entry, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:MedRecordTreatment, Bundle.entry:MedRecordTreatmentLine, Bundle.entry:MedRecordMedicationSummaryView, Bundle.entry:MedRecordOrder, Bundle.entry:MedRecordDispense, Bundle.entry:MedRecordAdministration, Bundle.entry:MedRecordMedicationScheduledAdministration, Bundle.entry:MedRecordUsage | 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&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:MedRecordTreatment, Bundle.entry:MedRecordTreatmentLine, Bundle.entry:MedRecordMedicationSummaryView, Bundle.entry:MedRecordOrder, Bundle.entry:MedRecordDispense, Bundle.entry:MedRecordAdministration, Bundle.entry:MedRecordMedicationScheduledAdministration, Bundle.entry:MedRecordUsage | fullUrl cannot be a version specific reference : fullUrl.exists() implies 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) | |
bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource : type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus) | |
bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history : type = 'history' implies entry.request.method != 'PATCH' | |
bdl-15 | error | Bundle | Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated : type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST') | |
bdl-16 | error | Bundle | Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. : issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning') | |
bdl-17 | error | Bundle | Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. : type = 'document' implies issues.empty() | |
bdl-18 | error | Bundle | Self link is required for searchsets. : type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists() | |
bdl-3a | error | Bundle | For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements : type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty()) | |
bdl-3b | error | Bundle | For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH : type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists())) | |
bdl-3c | error | Bundle | For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH : type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists())) | |
bdl-3d | error | Bundle | For collections of type transaction-response or batch-response, all entries must contain response elements : type in ('transaction-response' | 'batch-response') implies entry.all(response.exists()) | |
dom-2 | error | Bundle.entry:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Bundle.entry:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Bundle.entry:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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() | |
mdd-1 | error | Bundle.entry:MedRecordDispense.resource | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | C | 0..* | Bundle | Contains a collection of resources |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
identifier | SΣC | 0..1 | Identifier | Persistent identifier for the bundle |
type | ΣC | 1..1 | code | document Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document |
timestamp | ΣC | 0..1 | instant | When the bundle was assembled |
Slices for entry | ΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile: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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | ΣC | 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 - 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 | ΣC | 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 validation |
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:Composition | ΣC | 1..1 | BackboneElement | Composition 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordComposition | A set of resources composed into a single coherent clinical statement with clinical attestation |
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 - 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 | ΣC | 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 validation |
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 | ΣC | 1..1 | BackboneElement | Patient for whom the record is concerned 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | SΣC | 1..1 | Patient | 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 - 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 | ΣC | 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 validation |
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:MedRecordTreatment | ΣC | 0..* | BackboneElement | Treatments associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordTreatment | Healthcare plan for patient or group |
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 - 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 | ΣC | 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 validation |
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:MedRecordTreatmentLine | ΣC | 0..* | BackboneElement | Treatment lines associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordTreatmentLine | Record of medication being taken by a patient |
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 - 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 | ΣC | 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 validation |
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:MedRecordMedicationSummaryView | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordTreatmentLine | Record of medication being taken by a patient |
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 - 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 | ΣC | 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 validation |
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:MedRecordOrder | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordOrder | Ordering of medication for patient or group |
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 - 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 | ΣC | 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 validation |
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:MedRecordDispense | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | SC | 1..1 | MedRecordDispense | Dispensing a medication to a named patient |
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 - 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 | ΣC | 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 validation |
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:MedRecordAdministration | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordAdministration | Administration of medication to a patient |
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 - 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 | ΣC | 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 validation |
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:MedRecordMedicationScheduledAdministration | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordMedicationScheduledAdministration | Ordering of medication for patient or group |
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 - 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 | ΣC | 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 validation |
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:MedRecordUsage | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordUsage | Record of medication being taken by a patient |
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 - 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 | ΣC | 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 validation |
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 |
issues | ΣCTU | 0..1 | OperationOutcome | Issues with the Bundle |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Bundle.language | required | AllLanguages |
Bundle.type | required | Fixed Value: document |
Bundle.link.relation | required | LinkRelationTypes |
Bundle.entry.search.mode | required | SearchEntryMode |
Bundle.entry.request.method | required | HTTPVerb |
Bundle.entry:Composition.search.mode | required | SearchEntryMode |
Bundle.entry:Composition.request.method | required | HTTPVerb |
Bundle.entry:Patient.search.mode | required | SearchEntryMode |
Bundle.entry:Patient.request.method | required | HTTPVerb |
Bundle.entry:MedRecordTreatment.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordTreatment.request.method | required | HTTPVerb |
Bundle.entry:MedRecordTreatmentLine.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordTreatmentLine.request.method | required | HTTPVerb |
Bundle.entry:MedRecordMedicationSummaryView.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordMedicationSummaryView.request.method | required | HTTPVerb |
Bundle.entry:MedRecordOrder.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordOrder.request.method | required | HTTPVerb |
Bundle.entry:MedRecordDispense.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordDispense.request.method | required | HTTPVerb |
Bundle.entry:MedRecordAdministration.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordAdministration.request.method | required | HTTPVerb |
Bundle.entry:MedRecordMedicationScheduledAdministration.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordMedicationScheduledAdministration.request.method | required | HTTPVerb |
Bundle.entry:MedRecordUsage.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordUsage.request.method | required | HTTPVerb |
Id | Grade | Path(s) | Details | Requirements |
bdl-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
bdl-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not() | |
dom-2 | error | Bundle.entry:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Bundle.entry:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Bundle.entry:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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() | |
mdd-1 | error | Bundle.entry:MedRecordDispense.resource | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared |
This structure is derived from Bundle
Summary
Mandatory: 4 elements (8 nested mandatory elements)
Must-Support: 11 elements
Fixed Value: 1 element
Prohibited: 2 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 | |
identifier | S | 0..1 | Identifier | Persistent identifier for the bundle |
type | 1..1 | code | document Fixed Value: document | |
total | 0..0 | |||
link | 0..0 | |||
Slices for entry | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource | |
entry:Composition | 1..1 | BackboneElement | Composition | |
resource | S | 1..1 | MedRecordComposition | A set of resources composed into a single coherent clinical statement with clinical attestation |
entry:Patient | 1..1 | BackboneElement | Patient for whom the record is concerned | |
resource | S | 1..1 | Patient | A resource in the bundle |
entry:MedRecordTreatment | 0..* | BackboneElement | Treatments associated with the patient | |
resource | S | 1..1 | MedRecordTreatment | Healthcare plan for patient or group |
entry:MedRecordTreatmentLine | 0..* | BackboneElement | Treatment lines associated with the patient | |
resource | S | 1..1 | MedRecordTreatmentLine | Record of medication being taken by a patient |
entry:MedRecordMedicationSummaryView | 0..* | BackboneElement | Medication summaries associated with the patient | |
resource | S | 1..1 | MedRecordTreatmentLine | Record of medication being taken by a patient |
entry:MedRecordOrder | 0..* | BackboneElement | Medication summaries associated with the patient | |
resource | S | 1..1 | MedRecordOrder | Ordering of medication for patient or group |
entry:MedRecordDispense | 0..* | BackboneElement | Medication summaries associated with the patient | |
resource | S | 1..1 | MedRecordDispense | Dispensing a medication to a named patient |
entry:MedRecordAdministration | 0..* | BackboneElement | Medication summaries associated with the patient | |
resource | S | 1..1 | MedRecordAdministration | Administration of medication to a patient |
entry:MedRecordMedicationScheduledAdministration | 0..* | BackboneElement | Medication summaries associated with the patient | |
resource | S | 1..1 | MedRecordMedicationScheduledAdministration | Ordering of medication for patient or group |
entry:MedRecordUsage | 0..* | BackboneElement | Medication summaries associated with the patient | |
resource | S | 1..1 | MedRecordUsage | Record of medication being taken by a patient |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | C | 0..* | Bundle | Contains a collection of resources |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
identifier | SΣC | 0..1 | Identifier | Persistent identifier for the bundle |
type | ΣC | 1..1 | code | document Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document |
Slices for entry | ΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile: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 |
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | ΣC | 0..1 | Resource | A resource in the bundle |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:Composition | ΣC | 1..1 | BackboneElement | Composition 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordComposition | A set of resources composed into a single coherent clinical statement with clinical attestation |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:Patient | ΣC | 1..1 | BackboneElement | Patient for whom the record is concerned 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | SΣC | 1..1 | Patient | A resource in the bundle |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordTreatment | ΣC | 0..* | BackboneElement | Treatments associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordTreatment | Healthcare plan for patient or group |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordTreatmentLine | ΣC | 0..* | BackboneElement | Treatment lines associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordTreatmentLine | Record of medication being taken by a patient |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordMedicationSummaryView | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordTreatmentLine | Record of medication being taken by a patient |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordOrder | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordOrder | Ordering of medication for patient or group |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordDispense | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | SC | 1..1 | MedRecordDispense | Dispensing a medication to a named patient |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordAdministration | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordAdministration | Administration of medication to a patient |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordMedicationScheduledAdministration | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordMedicationScheduledAdministration | Ordering of medication for patient or group |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
entry:MedRecordUsage | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordUsage | Record of medication being taken by a patient |
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣC | 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 |
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
issues | ΣCTU | 0..1 | OperationOutcome | Issues with the Bundle |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Bundle.type | required | Fixed Value: document |
Bundle.link.relation | required | LinkRelationTypes |
Bundle.entry.request.method | required | HTTPVerb |
Bundle.entry:Composition.request.method | required | HTTPVerb |
Bundle.entry:Patient.request.method | required | HTTPVerb |
Bundle.entry:MedRecordTreatment.request.method | required | HTTPVerb |
Bundle.entry:MedRecordTreatmentLine.request.method | required | HTTPVerb |
Bundle.entry:MedRecordMedicationSummaryView.request.method | required | HTTPVerb |
Bundle.entry:MedRecordOrder.request.method | required | HTTPVerb |
Bundle.entry:MedRecordDispense.request.method | required | HTTPVerb |
Bundle.entry:MedRecordAdministration.request.method | required | HTTPVerb |
Bundle.entry:MedRecordMedicationScheduledAdministration.request.method | required | HTTPVerb |
Bundle.entry:MedRecordUsage.request.method | required | HTTPVerb |
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 : (type = 'searchset') or entry.search.empty() | |
bdl-5 | error | Bundle.entry, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:MedRecordTreatment, Bundle.entry:MedRecordTreatmentLine, Bundle.entry:MedRecordMedicationSummaryView, Bundle.entry:MedRecordOrder, Bundle.entry:MedRecordDispense, Bundle.entry:MedRecordAdministration, Bundle.entry:MedRecordMedicationScheduledAdministration, Bundle.entry:MedRecordUsage | 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&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:MedRecordTreatment, Bundle.entry:MedRecordTreatmentLine, Bundle.entry:MedRecordMedicationSummaryView, Bundle.entry:MedRecordOrder, Bundle.entry:MedRecordDispense, Bundle.entry:MedRecordAdministration, Bundle.entry:MedRecordMedicationScheduledAdministration, Bundle.entry:MedRecordUsage | fullUrl cannot be a version specific reference : fullUrl.exists() implies 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) | |
bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource : type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus) | |
bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history : type = 'history' implies entry.request.method != 'PATCH' | |
bdl-15 | error | Bundle | Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated : type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST') | |
bdl-16 | error | Bundle | Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. : issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning') | |
bdl-17 | error | Bundle | Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. : type = 'document' implies issues.empty() | |
bdl-18 | error | Bundle | Self link is required for searchsets. : type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists() | |
bdl-3a | error | Bundle | For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements : type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty()) | |
bdl-3b | error | Bundle | For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH : type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists())) | |
bdl-3c | error | Bundle | For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH : type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists())) | |
bdl-3d | error | Bundle | For collections of type transaction-response or batch-response, all entries must contain response elements : type in ('transaction-response' | 'batch-response') implies entry.all(response.exists()) | |
dom-2 | error | Bundle.entry:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Bundle.entry:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Bundle.entry:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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() | |
mdd-1 | error | Bundle.entry:MedRecordDispense.resource | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | C | 0..* | Bundle | Contains a collection of resources |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
identifier | SΣC | 0..1 | Identifier | Persistent identifier for the bundle |
type | ΣC | 1..1 | code | document Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document |
timestamp | ΣC | 0..1 | instant | When the bundle was assembled |
Slices for entry | ΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile: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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | ΣC | 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 - 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 | ΣC | 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 validation |
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:Composition | ΣC | 1..1 | BackboneElement | Composition 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordComposition | A set of resources composed into a single coherent clinical statement with clinical attestation |
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 - 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 | ΣC | 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 validation |
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 | ΣC | 1..1 | BackboneElement | Patient for whom the record is concerned 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | SΣC | 1..1 | Patient | 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 - 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 | ΣC | 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 validation |
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:MedRecordTreatment | ΣC | 0..* | BackboneElement | Treatments associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordTreatment | Healthcare plan for patient or group |
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 - 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 | ΣC | 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 validation |
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:MedRecordTreatmentLine | ΣC | 0..* | BackboneElement | Treatment lines associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordTreatmentLine | Record of medication being taken by a patient |
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 - 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 | ΣC | 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 validation |
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:MedRecordMedicationSummaryView | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordTreatmentLine | Record of medication being taken by a patient |
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 - 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 | ΣC | 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 validation |
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:MedRecordOrder | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordOrder | Ordering of medication for patient or group |
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 - 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 | ΣC | 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 validation |
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:MedRecordDispense | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | SC | 1..1 | MedRecordDispense | Dispensing a medication to a named patient |
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 - 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 | ΣC | 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 validation |
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:MedRecordAdministration | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordAdministration | Administration of medication to a patient |
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 - 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 | ΣC | 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 validation |
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:MedRecordMedicationScheduledAdministration | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordMedicationScheduledAdministration | Ordering of medication for patient or group |
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 - 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 | ΣC | 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 validation |
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:MedRecordUsage | ΣC | 0..* | BackboneElement | Medication summaries associated with the patient 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 | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | MedRecordUsage | Record of medication being taken by a patient |
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 - 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 | ΣC | 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 validation |
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 |
issues | ΣCTU | 0..1 | OperationOutcome | Issues with the Bundle |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Bundle.language | required | AllLanguages |
Bundle.type | required | Fixed Value: document |
Bundle.link.relation | required | LinkRelationTypes |
Bundle.entry.search.mode | required | SearchEntryMode |
Bundle.entry.request.method | required | HTTPVerb |
Bundle.entry:Composition.search.mode | required | SearchEntryMode |
Bundle.entry:Composition.request.method | required | HTTPVerb |
Bundle.entry:Patient.search.mode | required | SearchEntryMode |
Bundle.entry:Patient.request.method | required | HTTPVerb |
Bundle.entry:MedRecordTreatment.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordTreatment.request.method | required | HTTPVerb |
Bundle.entry:MedRecordTreatmentLine.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordTreatmentLine.request.method | required | HTTPVerb |
Bundle.entry:MedRecordMedicationSummaryView.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordMedicationSummaryView.request.method | required | HTTPVerb |
Bundle.entry:MedRecordOrder.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordOrder.request.method | required | HTTPVerb |
Bundle.entry:MedRecordDispense.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordDispense.request.method | required | HTTPVerb |
Bundle.entry:MedRecordAdministration.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordAdministration.request.method | required | HTTPVerb |
Bundle.entry:MedRecordMedicationScheduledAdministration.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordMedicationScheduledAdministration.request.method | required | HTTPVerb |
Bundle.entry:MedRecordUsage.search.mode | required | SearchEntryMode |
Bundle.entry:MedRecordUsage.request.method | required | HTTPVerb |
Id | Grade | Path(s) | Details | Requirements |
bdl-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
bdl-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not() | |
dom-2 | error | Bundle.entry:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Bundle.entry:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Bundle.entry:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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:Composition.resource, Bundle.entry:MedRecordTreatment.resource, Bundle.entry:MedRecordTreatmentLine.resource, Bundle.entry:MedRecordMedicationSummaryView.resource, Bundle.entry:MedRecordOrder.resource, Bundle.entry:MedRecordDispense.resource, Bundle.entry:MedRecordAdministration.resource, Bundle.entry:MedRecordMedicationScheduledAdministration.resource, Bundle.entry:MedRecordUsage.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() | |
mdd-1 | error | Bundle.entry:MedRecordDispense.resource | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared |
This structure is derived from Bundle
Summary
Mandatory: 4 elements (8 nested mandatory elements)
Must-Support: 11 elements
Fixed Value: 1 element
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron