Bundle & Message Header - New Fields
The Bundle and Message Header resources are mandatory across all transactions as they are essential in the FHIR message structure. The table below identifies new fields and the scope for MVP. The table does not include all structural elements, eg fields with fixed values as it focuses on new fields that are not in CPHA3. As such, it does not include fields that are mappable from the current CPHA3 standard. For a complete view of the PCS FHIR messages, refer to the bundle and the message profile section of this document, found here: Profile Summary Page
| Feature/Field | MVP Scope | Details | POS - Sender Responsibility | Adjudicator - Receiver Responsibility |
|---|---|---|---|---|
| Bundle | Bundle Profile | |||
| NEW FIELD id |
MANDATORY | Unique ID for the bundle | Must send | |
| NEW FIELD meta.tag |
MANDATORY | Identifies the message version and is therefore mandatory | Must send | May consume |
| NEW FIELD Timestamp |
MANDATORY | Time the bundle is created | Must send | May consume |
| NEW FIELD identifier |
MANDATORY | Persistent identifier for the bundle. This is used for guaranteed message delivery and is therefore mandatory | Must send | Must consume |
| NEW FIELD Total |
OPTIONAL | Used only for the Daily Totals and Adjudication results. If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. | Mandatory if paging is implemented | Mandatory if paging is implemented. |
| NEW FIELD Link |
OPTIONAL | Used only for the Daily Totals and Adjudication results | Mandatory if paging is implemented | Mandatory if paging is implemented. |
| Message Header - Request and Response | Profile for MessageHeaderRequest Profile for MessageHeaderRequest |
|||
| - | ||||
| NEW FIELD id |
MANDATORY | unique identifier for this request | Must send | Must consume |
| NEW FIELD destination.target.id |
OPTIONAL | Identifier for the network | Only used if requested by an identifier | Only used if requested by an identifier |
| NEW FIELD destination.url |
MANDATORY | Actual destination address or id | Must send | May consume |
| NEW FIELD source.name |
Optional | May be used to convey a name of a banner or POS-assigned pharmacy name for troubleshooting purposes | Optional - only send if requested by implementer | Optional |
| NEW FIELD Source.endpoint |
MANDATORY | Mandatory in FHIR; may from CPHA3 Active Device ID A.07.03. This is the source address ID | Must send | May consume |
| NEW FIELD Response.identifier |
MANDATORY | This links the request to the response. The MessageHeader.id of the message to which this message is a response. | Mandatory in responses | Mandatory |
| NEW FIELD Response.code |
MANDATORY | Provides a high-level disposition and is mandatory on all responses. eg "ok", or "transient error" | Mandatory in responses | Should consume |
| NEW FIELD Response.code |
MANDATORY | Mandatory reference to the key resource, eg Claim in a Claim Request, or Claim Response, is a Claim response | Mandatory in responses | Must consume |