Da Vinci - Prior Authorization Support
0.1.0 - STU Ballot
Da Vinci - Prior Authorization Support
0.1.0 - STU Ballot
This page is part of the Da Vinci Prior Authorization Support (PAS) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-bundle
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
Summary
Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 6 elements
Fixed Value: 1 element
Prohibited: 6 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle | 0..* | |||
  type | 1..1 | code | Fixed Value: collection | |
  entry | S | (Slice Definition) | Slice: Unordered, Open by value:resource | |
  (All Slices) | Content/Rules for all slices | |||
 fullUrl | S | 1..1 | uri | |
| resource | S | 1..1 | Resource | |
| search | 0..0 | |||
| request | 0..0 | |||
 response | 0..0 | |||
| ClaimOrResponse | S | 1..1 | BackboneElement | |
 fullUrl | S | 1..1 | uri | |
 resource | S | 1..1 | ||
  resource | Claim | |||
| resource | ClaimResponse | |||
| search | 0..0 | |||
| request | 0..0 | |||
 response | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | I | 0..* | 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: CommonLanguages (preferred) Max Binding: AllLanguages | |
| identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle |
| type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: collection |
| timestamp | Σ | 0..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 | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
| url | Σ | 1..1 | uri | Reference details for the link |
| entry | SΣI | (Slice Definition) | Entry in the bundle - will have a resource or information Slice: Unordered, Open by value: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 | |
| (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..* | Unknown reference to #Bundle.link Links related to this entry | |
| fullUrl | SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
 resource | SΣ | 1..1 | Resource | A resource in the bundle |
| ClaimOrResponse | SΣI | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| link | Σ | 0..* | Unknown reference to #Bundle.link Links related to this entry | |
| fullUrl | SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | SΣ | 1..1 | A resource in the bundle | |
| resource | Claim | |||
| resource | ClaimResponse | |||
| signature | Σ | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
This structure is derived from Bundle
Summary
Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 6 elements
Fixed Value: 1 element
Prohibited: 6 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..* | |||
| type | 1..1 | code | Fixed Value: collection | |
| entry | S | (Slice Definition) | Slice: Unordered, Open by value:resource | |
| (All Slices) | Content/Rules for all slices | |||
| fullUrl | S | 1..1 | uri | |
| resource | S | 1..1 | Resource | |
| search | 0..0 | |||
| request | 0..0 | |||
| response | 0..0 | |||
| ClaimOrResponse | S | 1..1 | BackboneElement | |
| fullUrl | S | 1..1 | uri | |
| resource | S | 1..1 | ||
| resource | Claim | |||
| resource | ClaimResponse | |||
| search | 0..0 | |||
| request | 0..0 | |||
| response | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | I | 0..* | 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: CommonLanguages (preferred) Max Binding: AllLanguages | |
| identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle |
| type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: collection |
| timestamp | Σ | 0..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 | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
| url | Σ | 1..1 | uri | Reference details for the link |
| entry | SΣI | (Slice Definition) | Entry in the bundle - will have a resource or information Slice: Unordered, Open by value: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 | |
| (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..* | Unknown reference to #Bundle.link Links related to this entry | |
| fullUrl | SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | SΣ | 1..1 | Resource | A resource in the bundle |
| ClaimOrResponse | SΣI | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| link | Σ | 0..* | Unknown reference to #Bundle.link Links related to this entry | |
| fullUrl | SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | SΣ | 1..1 | A resource in the bundle | |
| resource | Claim | |||
| resource | ClaimResponse | |||
| signature | Σ | 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.type | required | Fixed Value: collection |
| Bundle.entry.search.mode | required | SearchEntryMode |
| Bundle.entry.request.method | required | HTTPVerb |
| Bundle.entry:ClaimOrResponse.search.mode | required | SearchEntryMode |
| Bundle.entry:ClaimOrResponse.request.method | required | HTTPVerb |
| Id | Path | Details | Requirements |
| 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-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-12 | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| 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-11 | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-10 | Bundle | A document must have a date : type = 'document' implies (meta.lastUpdated.hasValue()) | |
| ele-1 | Bundle.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| bdl-8 | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
| bdl-5 | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| ele-1 | Bundle.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| bdl-8 | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
| bdl-5 | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
IG © 2019+ HL7 International - Financial Management Work Group. Package hl7.fhir.us.davinci-pas#0.1.0 based on FHIR 4.0.0. Generated 2019-08-05
Links: Table of Contents |
QA Report | Search |
Version History |
|
Propose a change