This page is part of the Post Acute Orders FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
PAO Bundle profile that includes a MessageHeader, MessageDefinition, Task, Subscription, service/device/medication order(s) and supporting documentation
The official URL for this profile is:
http://hl7.org/fhir/us/dme-orders/StructureDefinition/PAO-bundle4
The intro section will be expanded in the STU version
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | 0..* | Bundle | Contains a collection of resources | |
identifier | S | 1..1 | Identifier | Persistent identifier for the bundle |
value | S | 1..1 | string | The value that is unique |
id | S | 1..1 | string | xml:id (or equivalent in JSON) |
type | S | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: message |
timestamp | S | 1..1 | instant | When the bundle was assembled |
entry | S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information |
resource | S | 1..1 | PAOmessageheader | A resource that describes a message that is exchanged between systems |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | I | 0..* | Bundle | Contains a collection of resources |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
identifier | SΣI | 1..1 | Identifier | Persistent identifier for the bundle |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣI | 1..1 | string | The value that is unique Example General: 123456 |
id | S | 1..1 | string | xml:id (or equivalent in JSON) |
extension | I | 0..* | Extension | Additional content defined by implementations |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
type | SΣI | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: message |
timestamp | SΣI | 1..1 | instant | When the bundle was assembled |
total | ΣI | 0..1 | unsignedInt | If search, the total number of matches |
link | ΣI | 0..* | BackboneElement | Links related to this Bundle |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
relation | ΣI | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
url | ΣI | 1..1 | uri | Reference details for the link |
entry | SΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
link | ΣI | 0..* | Unknown reference to #Bundle.link Links related to this entry | |
fullUrl | ΣI | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | SI | 1..1 | PAOmessageheader | A resource that describes a message that is exchanged between systems |
search | ΣI | 0..1 | BackboneElement | Search related information |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
mode | ΣI | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required) |
score | ΣI | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣI | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required) |
url | ΣI | 1..1 | uri | URL for HTTP equivalent of this entry |
ifNoneMatch | ΣI | 0..1 | string | For managing cache currency |
ifModifiedSince | ΣI | 0..1 | instant | For managing cache currency |
ifMatch | ΣI | 0..1 | string | For managing update contention |
ifNoneExist | ΣI | 0..1 | string | For conditional creates |
response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | ΣI | 1..1 | string | Status response code (text optional) |
location | ΣI | 0..1 | uri | The location (if the operation returns a location) |
etag | ΣI | 0..1 | string | The Etag for the resource (if relevant) |
lastModified | ΣI | 0..1 | instant | Server's date time modified |
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
signature | ΣI | 0..1 | Signature | Digital Signature |
Documentation for this format |
This structure is derived from Bundle
Differential View
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | 0..* | Bundle | Contains a collection of resources | |
identifier | S | 1..1 | Identifier | Persistent identifier for the bundle |
value | S | 1..1 | string | The value that is unique |
id | S | 1..1 | string | xml:id (or equivalent in JSON) |
type | S | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: message |
timestamp | S | 1..1 | instant | When the bundle was assembled |
entry | S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information |
resource | S | 1..1 | PAOmessageheader | A resource that describes a message that is exchanged between systems |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | I | 0..* | Bundle | Contains a collection of resources |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
identifier | SΣI | 1..1 | Identifier | Persistent identifier for the bundle |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣI | 1..1 | string | The value that is unique Example General: 123456 |
id | S | 1..1 | string | xml:id (or equivalent in JSON) |
extension | I | 0..* | Extension | Additional content defined by implementations |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
type | SΣI | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: message |
timestamp | SΣI | 1..1 | instant | When the bundle was assembled |
total | ΣI | 0..1 | unsignedInt | If search, the total number of matches |
link | ΣI | 0..* | BackboneElement | Links related to this Bundle |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
relation | ΣI | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
url | ΣI | 1..1 | uri | Reference details for the link |
entry | SΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
link | ΣI | 0..* | Unknown reference to #Bundle.link Links related to this entry | |
fullUrl | ΣI | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | SI | 1..1 | PAOmessageheader | A resource that describes a message that is exchanged between systems |
search | ΣI | 0..1 | BackboneElement | Search related information |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
mode | ΣI | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required) |
score | ΣI | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
method | ΣI | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required) |
url | ΣI | 1..1 | uri | URL for HTTP equivalent of this entry |
ifNoneMatch | ΣI | 0..1 | string | For managing cache currency |
ifModifiedSince | ΣI | 0..1 | instant | For managing cache currency |
ifMatch | ΣI | 0..1 | string | For managing update contention |
ifNoneExist | ΣI | 0..1 | string | For conditional creates |
response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | ΣI | 1..1 | string | Status response code (text optional) |
location | ΣI | 0..1 | uri | The location (if the operation returns a location) |
etag | ΣI | 0..1 | string | The Etag for the resource (if relevant) |
lastModified | ΣI | 0..1 | instant | Server's date time modified |
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
signature | ΣI | 0..1 | Signature | Digital Signature |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet / Code |
Bundle.language | preferred | CommonLanguages Max Binding: AllLanguages |
Bundle.identifier.use | required | IdentifierUse |
Bundle.identifier.type | extensible | Identifier Type Codes |
Bundle.type | required | Fixed Value: message |
Bundle.entry.search.mode | required | SearchEntryMode |
Bundle.entry.request.method | required | HTTPVerb |
Id | Path | Details | Requirements |
bdl-1 | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
bdl-2 | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
bdl-3 | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
bdl-4 | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) | |
bdl-7 | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
bdl-9 | 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 | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
bdl-11 | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
bdl-12 | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
ele-1 | Bundle.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.identifier.value.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.identifier.value.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.timestamp | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.total | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.link.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.link.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.link.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.link.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.link.relation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.link.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
bdl-5 | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
bdl-8 | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
ele-1 | Bundle.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.fullUrl | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
dom-2 | Bundle.entry.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | Bundle.entry.resource | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | Bundle.entry.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 | Bundle.entry.resource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Bundle.entry.resource | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | Bundle.entry.search | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.search.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.search.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.search.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.search.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.search.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.search.score | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.request.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.request.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.request.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.request.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request.ifNoneMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request.ifModifiedSince | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request.ifMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request.ifNoneExist | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.response | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.response.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.response.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.response.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.response.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.response.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.response.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.response.etag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.response.lastModified | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.signature | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
The notes section will be expanded in the STU version