This page is part of the Consumer Real-time Pharmacy Benefit Check (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
SD.11 StructureDefinition-carin-rtpbc-request-bundle
This profile constrains a Bundle resource for use as the request in a Real-time Pharmacy Benefit Check (RTPBC) process.
The request Bundle profile identifies the resources to be submitted in an RTPBC request. The following are used in all circumstances and have a minimum cardinality of 1:
- Claim
- Patient
- MedicationRequest
- Pharmacy
- Practitioner
- In addition, the Coverage resource is necessary when submitting a request to an insurer or other agent representing the patient’s pharmacy benefit. It’s minimum cardinality is 0.
Must Support elements in this profile
Client systems
- All the above Bundle resource entries are designated Must Support. The required elements MUST be populated with correct and complete information in order to elicit reliable information in the RTPBC response.
- When submitting to an insurer, the Coverage resource MUST also be populated.
Responding insurer systems
- MUST accept all Must Support resources and make use of provided information when determining cost and coverage
Responding discount pricing sources
- Must accept Claim, Patient, MedicationRequest, Pharmacy and Practitioner resources and use as applicable when determining pricing information
SD.11.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-request-bundle
Published on Sun Dec 08 05:00:00 UTC 2019 as a active by CARIN Alliance.
This profile builds on Bundle
Summary
Mandatory: 13 elements
Must-Support: 16 elements
Fixed Value: 1 element
Prohibited: 4 elements
Structures
This structure refers to these other structures:
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-request-messageheader
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-request
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-patient
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-medicationrequest
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-pharmacy
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-practitioner
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-coverage
Slices
This structure defines the following Slices:
- The element Bundle.entry is sliced based on the value of type:resource
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle | 0..* | Bundle | ||
  type | S | 1..1 | code | Fixed Value: message |
 total | 0..0 | |||
  entry | S | 6..* | (Slice Definition) | Slice: Unordered, Open by type:resource |
  entry:All Slices | Content/Rules for all slices | |||
 search | 0..0 | |||
| request | 0..0 | |||
 response | 0..0 | |||
 entry:messageheader | S | 1..1 | BackboneElement | |
 resource | S | 1..1 | CarinRtpbcRequestMessageHeader | |
| entry:claim | S | 1..1 | BackboneElement | |
| resource | S | 1..1 | CarinRtpbcRequest | |
| entry:patient | S | 1..1 | BackboneElement | |
| resource | S | 1..1 | CarinRtpbcPatient | |
| entry:medicationrequest | S | 1..1 | BackboneElement | |
| resource | S | 1..1 | CarinRtpbcMedicationRequest | |
| entry:pharmacy | S | 1..1 | BackboneElement | |
| resource | S | 1..1 | CarinRtpbcPharmacy | |
| entry:practitioner | S | 1..1 | BackboneElement | |
| resource | S | 1..1 | CarinRtpbcPractitioner | |
| entry:coverage | S | 1..1 | BackboneElement | |
| resource | S | 0..1 | CarinRtpbcCoverage | |
| 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 | ΣI | 0..1 | Identifier | Persistent identifier for the bundle |
| type | SΣI | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: message |
| timestamp | ΣI | 0..1 | instant | When the bundle was assembled |
| 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 | 6..* | (Slice Definition) | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| entry:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 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 | Σ | 0..1 | Resource | A resource in the bundle |
| entry:messageheader | 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 | 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 | CarinRtpbcRequestMessageHeader | 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) |
| entry:claim | 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 | 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 | CarinRtpbcRequest | Claim, Pre-determination or Pre-authorization |
| 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) |
| entry:patient | 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 | 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 | CarinRtpbcPatient | Information about an individual or animal receiving health care services |
| 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) |
| entry:medicationrequest | 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 | 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 | CarinRtpbcMedicationRequest | Ordering of medication for patient or group |
| 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) |
| entry:pharmacy | 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 | 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 | CarinRtpbcPharmacy | A grouping of people or organizations with a common purpose |
| 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) |
| entry:practitioner | 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 | 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 | CarinRtpbcPractitioner | A person with a formal responsibility in the provisioning of healthcare or related services |
| 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) |
| entry:coverage | 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 | 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 | 0..1 | CarinRtpbcCoverage | Insurance or medical plan or a payment agreement |
| 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 | ||||
Summary
Mandatory: 13 elements
Must-Support: 16 elements
Fixed Value: 1 element
Prohibited: 4 elements
Structures
This structure refers to these other structures:
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-request-messageheader
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-request
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-patient
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-medicationrequest
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-pharmacy
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-practitioner
- http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-coverage
Slices
This structure defines the following Slices:
- The element Bundle.entry is sliced based on the value of type:resource
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | 0..* | Bundle | ||
| type | S | 1..1 | code | Fixed Value: message |
| total | 0..0 | |||
| entry | S | 6..* | (Slice Definition) | Slice: Unordered, Open by type:resource |
| entry:All Slices | Content/Rules for all slices | |||
| search | 0..0 | |||
| request | 0..0 | |||
| response | 0..0 | |||
| entry:messageheader | S | 1..1 | BackboneElement | |
| resource | S | 1..1 | CarinRtpbcRequestMessageHeader | |
| entry:claim | S | 1..1 | BackboneElement | |
| resource | S | 1..1 | CarinRtpbcRequest | |
| entry:patient | S | 1..1 | BackboneElement | |
| resource | S | 1..1 | CarinRtpbcPatient | |
| entry:medicationrequest | S | 1..1 | BackboneElement | |
| resource | S | 1..1 | CarinRtpbcMedicationRequest | |
| entry:pharmacy | S | 1..1 | BackboneElement | |
| resource | S | 1..1 | CarinRtpbcPharmacy | |
| entry:practitioner | S | 1..1 | BackboneElement | |
| resource | S | 1..1 | CarinRtpbcPractitioner | |
| entry:coverage | S | 1..1 | BackboneElement | |
| resource | S | 0..1 | CarinRtpbcCoverage | |
| 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 | ΣI | 0..1 | Identifier | Persistent identifier for the bundle |
| type | SΣI | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: message |
| timestamp | ΣI | 0..1 | instant | When the bundle was assembled |
| 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 | 6..* | (Slice Definition) | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| entry:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 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 | Σ | 0..1 | Resource | A resource in the bundle |
| entry:messageheader | 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 | 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 | CarinRtpbcRequestMessageHeader | 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) |
| entry:claim | 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 | 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 | CarinRtpbcRequest | Claim, Pre-determination or Pre-authorization |
| 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) |
| entry:patient | 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 | 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 | CarinRtpbcPatient | Information about an individual or animal receiving health care services |
| 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) |
| entry:medicationrequest | 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 | 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 | CarinRtpbcMedicationRequest | Ordering of medication for patient or group |
| 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) |
| entry:pharmacy | 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 | 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 | CarinRtpbcPharmacy | A grouping of people or organizations with a common purpose |
| 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) |
| entry:practitioner | 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 | 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 | CarinRtpbcPractitioner | A person with a formal responsibility in the provisioning of healthcare or related services |
| 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) |
| entry:coverage | 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 | 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 | 0..1 | CarinRtpbcCoverage | Insurance or medical plan or a payment agreement |
| 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 | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
