Post-Acute FHIR Based Orders
0.1.0 - STU 1 Ballot

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

StructureDefinition: PAObundle4

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

Formal Views of Profile Content

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

This structure is derived from Bundle

Summary

Mandatory: 6 elements
Must-Support: 7 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleContains a collection of resources
... identifier S1..1IdentifierPersistent identifier for the bundle
.... value S1..1stringThe value that is unique
..... id S1..1stringxml:id (or equivalent in JSON)
... type S1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: message
... timestamp S1..1instantWhen the bundle was assembled
.... resource S1..1PAOmessageheaderA resource that describes a message that is exchanged between systems

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleContains a collection of resources
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... identifier SΣI1..1IdentifierPersistent identifier for the bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣI1..1stringThe value that is unique
Example General: 123456
..... id S1..1stringxml:id (or equivalent in JSON)
..... extension I0..*ExtensionAdditional content defined by implementations
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... period ΣI0..1PeriodTime period when id is/was valid for use
.... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... type SΣI1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: message
... timestamp SΣI1..1instantWhen the bundle was assembled
... total ΣI0..1unsignedIntIf search, the total number of matches
... link ΣI0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation ΣI1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url ΣI1..1uriReference details for the link
... entry SΣI1..*BackboneElementEntry 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..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
.... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
.... resource SI1..1PAOmessageheaderA resource that describes a message that is exchanged between systems
.... search ΣI0..1BackboneElementSearch related information
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
..... score ΣI0..1decimalSearch ranking (between 0 and 1)
.... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
..... url ΣI1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch ΣI0..1stringFor managing cache currency
..... ifModifiedSince ΣI0..1instantFor managing cache currency
..... ifMatch ΣI0..1stringFor managing update contention
..... ifNoneExist ΣI0..1stringFor conditional creates
.... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... status ΣI1..1stringStatus response code (text optional)
..... location ΣI0..1uriThe location (if the operation returns a location)
..... etag ΣI0..1stringThe Etag for the resource (if relevant)
..... lastModified ΣI0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature ΣI0..1SignatureDigital Signature

doco Documentation for this format

This structure is derived from Bundle

Summary

Mandatory: 6 elements
Must-Support: 7 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleContains a collection of resources
... identifier S1..1IdentifierPersistent identifier for the bundle
.... value S1..1stringThe value that is unique
..... id S1..1stringxml:id (or equivalent in JSON)
... type S1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: message
... timestamp S1..1instantWhen the bundle was assembled
.... resource S1..1PAOmessageheaderA resource that describes a message that is exchanged between systems

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleContains a collection of resources
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... identifier SΣI1..1IdentifierPersistent identifier for the bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣI1..1stringThe value that is unique
Example General: 123456
..... id S1..1stringxml:id (or equivalent in JSON)
..... extension I0..*ExtensionAdditional content defined by implementations
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... period ΣI0..1PeriodTime period when id is/was valid for use
.... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... type SΣI1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: message
... timestamp SΣI1..1instantWhen the bundle was assembled
... total ΣI0..1unsignedIntIf search, the total number of matches
... link ΣI0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation ΣI1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url ΣI1..1uriReference details for the link
... entry SΣI1..*BackboneElementEntry 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..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
.... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
.... resource SI1..1PAOmessageheaderA resource that describes a message that is exchanged between systems
.... search ΣI0..1BackboneElementSearch related information
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
..... score ΣI0..1decimalSearch ranking (between 0 and 1)
.... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
..... url ΣI1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch ΣI0..1stringFor managing cache currency
..... ifModifiedSince ΣI0..1instantFor managing cache currency
..... ifMatch ΣI0..1stringFor managing update contention
..... ifNoneExist ΣI0..1stringFor conditional creates
.... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... status ΣI1..1stringStatus response code (text optional)
..... location ΣI0..1uriThe location (if the operation returns a location)
..... etag ΣI0..1stringThe Etag for the resource (if relevant)
..... lastModified ΣI0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature ΣI0..1SignatureDigital Signature

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languagepreferredCommonLanguages
Max Binding: AllLanguages
Bundle.identifier.userequiredIdentifierUse
Bundle.identifier.typeextensibleIdentifier Type Codes
Bundle.typerequiredFixed Value: message
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb

Constraints

Constraints

IdPathDetailsRequirements
bdl-1Bundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2Bundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3Bundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4Bundleentry.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-7BundleFullUrl 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-9BundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10BundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11BundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12BundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1Bundle.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.identifier.value.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.identifier.value.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.timestampAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.totalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.link.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.link.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.link.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.link.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.link.relationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.link.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
bdl-5Bundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-8Bundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
ele-1Bundle.entryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.fullUrlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
dom-2Bundle.entry.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3Bundle.entry.resourceIf 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-4Bundle.entry.resourceIf 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-5Bundle.entry.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Bundle.entry.resourceA resource should have narrative for robust management
: text.`div`.exists()
ele-1Bundle.entry.searchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.search.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.search.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.search.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.search.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.search.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.search.scoreAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.requestAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.request.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.request.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.request.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.request.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.request.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.request.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.request.ifNoneMatchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.request.ifModifiedSinceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.request.ifMatchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.request.ifNoneExistAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.responseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.response.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.response.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.response.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.response.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.response.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.response.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.response.etagAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.response.lastModifiedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.signatureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

The notes section will be expanded in the STU version