AU eRequesting Implementation Guide
1.0.1-ci-build - CI Build
AU eRequesting Implementation Guide
1.0.1-ci-build - CI Build
AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-erequesting/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-bundle-diagnosticrequest | Version: 1.0.1-ci-build | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: AUeRequestingDiagnosticRequestBundle | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a Bundle resource that packages the FHIR resources required to create a new diagnostic request (pathology or imaging) as a single FHIR transaction. It is an abstract profile defining the common shape; concrete profiles for pathology and imaging requests derive from it. The bundle gathers the placer's view of the request — the ServiceRequest(s), the placer-side Task Group and Task Diagnostic Request(s), the patient and requesting clinician/organization, and any supporting resources (encounter, coverage, clinical context document, communication requests, supporting observations, filler organization, location). Entries use urn:uuid: fullUrls and POST request methods to create new resources. Actor entries may optionally use conditional create (POST with ifNoneExist) or conditional update (PUT) when the placer knows the actor's identifier on the target server.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Bundle |
C | 0..* | Bundle | This is an abstract profile. Child profiles: AUeRequestingPathologyRequestBundle, AUeRequestingImagingRequestBundle Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, au-ereq-bundle-01, au-ereq-bundle-02, au-ereq-bundle-03, au-ereq-bundle-04, au-ereq-bundle-06, au-ereq-bundle-07 | ||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| type |
SOΣ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: transaction
| ||||||||
  Slices for entry |
SOΣC | 7..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource, profile:resource Constraints: bdl-5, bdl-8 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 | |||||||||||
   modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
 entry:patient |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPatient | A patient in the context of electronic exchange of health information | |||||||||
  request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
 ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| entry:requestingPractitioner |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPractitioner | A person with a formal responsibility in the provisioning of services | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| entry:requestingPractitionerRole |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| entry:organization |
SOΣC | 1..2 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingOrganization | An organisation in an Australian healthcare context | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| entry:serviceRequest |
SOΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingDiagnosticRequest | A service request in an Australian healthcare context | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:taskGroup |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingTaskGroup | A task to be performed | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:taskDiagnosticRequest |
SOΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingTaskDiagnosticRequest | A task to be performed | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:encounter |
SOΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingEncounter | An encounter in an Australian healthcare context | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:coverage |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingCoverage | Insurance or medical plan or a payment agreement | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:clinicalContextDocument |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingClinicalContextDocumentReference | A reference to a document | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:communicationRequest |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingCommunicationRequestCopyTo, AUeRequestingCommunicationRequestUrgentProvider, AUeRequestingCommunicationRequestPatient | A request for information to be sent to a receiver | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:supportingObservation |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
Σ | 1..1 | Observation | A resource in the bundle | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
 entry:location |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
Σ | 1..1 | Location | A resource in the bundle | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requestingPractitioner.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requestingPractitionerRole.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:serviceRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:taskGroup.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:taskDiagnosticRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:encounter.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:coverage.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:clinicalContextDocument.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:communicationRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:supportingObservation.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:location.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-ereq-bundle-01 | error | Bundle | The number of Task Diagnostic Request entries shall equal the number of ServiceRequest entries. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).count() = entry.where(resource is ServiceRequest).count()
|
| au-ereq-bundle-02 | error | Bundle | Every Task Diagnostic Request focus reference shall resolve to a ServiceRequest entry within the bundle. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.focus.reference in %resource.entry.fullUrl)
|
| au-ereq-bundle-03 | error | Bundle | Every Task Diagnostic Request partOf reference shall resolve to the Task Group entry within the bundle. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.partOf.reference in %resource.entry.where(resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-group').exists()).fullUrl)
|
| au-ereq-bundle-04 | error | Bundle | Every entry.fullUrl shall be a urn:uuid: value with a lowercase UUID. |
entry.all(fullUrl.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'))
|
| au-ereq-bundle-06 | error | Bundle | The placer identifier value shall be unique across all ServiceRequest entries in the bundle. The placer identifier (ServiceRequest.identifier slice 'placer', type PLAC) is the per-test handle used by the $transfer operation; duplicate values would make a partial transfer ambiguous. |
entry.where(resource is ServiceRequest).select(resource.identifier.where(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PLAC').exists()).value).isDistinct()
|
| au-ereq-bundle-07 | error | Bundle | Every entry request method shall be POST or PUT. The bundle creates resources (POST, optionally with ifNoneExist) or conditionally updates them by identifier (PUT); read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted in a diagnostic request submission. |
entry.all(request.method = 'POST' or request.method = 'PUT')
|
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | This is an abstract profile. Child profiles: AUeRequestingPathologyRequestBundle, AUeRequestingImagingRequestBundle Contains a collection of resources Constraints: au-ereq-bundle-01, au-ereq-bundle-02, au-ereq-bundle-03, au-ereq-bundle-04, au-ereq-bundle-06, au-ereq-bundle-07 | ||||||||
| type |
SO | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: transaction
| ||||||||
| Slices for entry |
SO | 7..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource, profile:resource
| ||||||||
| entry:All Slices |
Content/Rules for all slices | |||||||||||
| request |
||||||||||||
| method |
1..1 | code | POST | PUT (create or conditional update only) | |||||||||
| entry:patient |
SO | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPatient | A patient in the context of electronic exchange of health information | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST | PUT (create or conditional update only)
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SO | 0..1 | string | For conditional creates
| ||||||||
| entry:requestingPractitioner |
SO | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPractitioner | A person with a formal responsibility in the provisioning of services | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST | PUT (create or conditional update only)
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SO | 0..1 | string | For conditional creates
| ||||||||
| entry:requestingPractitionerRole |
SO | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST | PUT (create or conditional update only)
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SO | 0..1 | string | For conditional creates
| ||||||||
| entry:organization |
SO | 1..2 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingOrganization | An organisation in an Australian healthcare context | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST | PUT (create or conditional update only)
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SO | 0..1 | string | For conditional creates
| ||||||||
| entry:serviceRequest |
SO | 1..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingDiagnosticRequest | A service request in an Australian healthcare context | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:taskGroup |
SO | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingTaskGroup | A task to be performed | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:taskDiagnosticRequest |
SO | 1..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingTaskDiagnosticRequest | A task to be performed | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:encounter |
SO | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingEncounter | An encounter in an Australian healthcare context | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:coverage |
SO | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingCoverage | Insurance or medical plan or a payment agreement | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:clinicalContextDocument |
SO | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingClinicalContextDocumentReference | A reference to a document | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:communicationRequest |
SO | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingCommunicationRequestCopyTo, AUeRequestingCommunicationRequestUrgentProvider, AUeRequestingCommunicationRequestPatient | A request for information to be sent to a receiver | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:supportingObservation |
SO | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | Observation | A resource in the bundle | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:location |
SO | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | Location | A resource in the bundle | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| Documentation for this format | ||||||||||||
| Id | Grade | Path(s) | Description | Expression |
| au-ereq-bundle-01 | error | Bundle | The number of Task Diagnostic Request entries shall equal the number of ServiceRequest entries. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).count() = entry.where(resource is ServiceRequest).count()
|
| au-ereq-bundle-02 | error | Bundle | Every Task Diagnostic Request focus reference shall resolve to a ServiceRequest entry within the bundle. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.focus.reference in %resource.entry.fullUrl)
|
| au-ereq-bundle-03 | error | Bundle | Every Task Diagnostic Request partOf reference shall resolve to the Task Group entry within the bundle. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.partOf.reference in %resource.entry.where(resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-group').exists()).fullUrl)
|
| au-ereq-bundle-04 | error | Bundle | Every entry.fullUrl shall be a urn:uuid: value with a lowercase UUID. |
entry.all(fullUrl.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'))
|
| au-ereq-bundle-06 | error | Bundle | The placer identifier value shall be unique across all ServiceRequest entries in the bundle. The placer identifier (ServiceRequest.identifier slice 'placer', type PLAC) is the per-test handle used by the $transfer operation; duplicate values would make a partial transfer ambiguous. |
entry.where(resource is ServiceRequest).select(resource.identifier.where(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PLAC').exists()).value).isDistinct()
|
| au-ereq-bundle-07 | error | Bundle | Every entry request method shall be POST or PUT. The bundle creates resources (POST, optionally with ifNoneExist) or conditionally updates them by identifier (PUT); read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted in a diagnostic request submission. |
entry.all(request.method = 'POST' or request.method = 'PUT')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | This is an abstract profile. Child profiles: AUeRequestingPathologyRequestBundle, AUeRequestingImagingRequestBundle Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, au-ereq-bundle-01, au-ereq-bundle-02, au-ereq-bundle-03, au-ereq-bundle-04, au-ereq-bundle-06, au-ereq-bundle-07 | ||||||||
| 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): A human language.
| |||||||||
| identifier |
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||||||
| type |
SOΣ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: transaction
| ||||||||
| timestamp |
Σ | 0..1 | instant | When the bundle was assembled | ||||||||
| total |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||||||
 link |
Σ | 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 | ||||||||
| Slices for entry |
SOΣC | 7..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource, profile:resource Constraints: bdl-5, bdl-8 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 |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| resource |
Σ | 0..1 | Resource | A resource in the bundle | ||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
Σ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||||||
| url |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:patient |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPatient | A patient in the context of electronic exchange of health information | |||||||||
 search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:requestingPractitioner |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPractitioner | A person with a formal responsibility in the provisioning of services | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:requestingPractitionerRole |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:organization |
SOΣC | 1..2 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingOrganization | An organisation in an Australian healthcare context | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:serviceRequest |
SOΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingDiagnosticRequest | A service request in an Australian healthcare context | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:taskGroup |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingTaskGroup | A task to be performed | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:taskDiagnosticRequest |
SOΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingTaskDiagnosticRequest | A task to be performed | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:encounter |
SOΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingEncounter | An encounter in an Australian healthcare context | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:coverage |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingCoverage | Insurance or medical plan or a payment agreement | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:clinicalContextDocument |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingClinicalContextDocumentReference | A reference to a document | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:communicationRequest |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingCommunicationRequestCopyTo, AUeRequestingCommunicationRequestUrgentProvider, AUeRequestingCommunicationRequestPatient | A request for information to be sent to a receiver | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:supportingObservation |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
Σ | 1..1 | Observation | A resource in the bundle | ||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:location |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
Σ | 1..1 | Location | A resource in the bundle | ||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| signature |
Σ | 0..1 | Signature | Digital Signature | ||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requestingPractitioner.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requestingPractitioner.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requestingPractitionerRole.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requestingPractitionerRole.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:serviceRequest.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:serviceRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:taskGroup.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:taskGroup.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:taskDiagnosticRequest.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:taskDiagnosticRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:encounter.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:encounter.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:coverage.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:coverage.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:clinicalContextDocument.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:clinicalContextDocument.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:communicationRequest.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:communicationRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:supportingObservation.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:supportingObservation.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:location.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:location.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-ereq-bundle-01 | error | Bundle | The number of Task Diagnostic Request entries shall equal the number of ServiceRequest entries. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).count() = entry.where(resource is ServiceRequest).count()
|
| au-ereq-bundle-02 | error | Bundle | Every Task Diagnostic Request focus reference shall resolve to a ServiceRequest entry within the bundle. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.focus.reference in %resource.entry.fullUrl)
|
| au-ereq-bundle-03 | error | Bundle | Every Task Diagnostic Request partOf reference shall resolve to the Task Group entry within the bundle. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.partOf.reference in %resource.entry.where(resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-group').exists()).fullUrl)
|
| au-ereq-bundle-04 | error | Bundle | Every entry.fullUrl shall be a urn:uuid: value with a lowercase UUID. |
entry.all(fullUrl.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'))
|
| au-ereq-bundle-06 | error | Bundle | The placer identifier value shall be unique across all ServiceRequest entries in the bundle. The placer identifier (ServiceRequest.identifier slice 'placer', type PLAC) is the per-test handle used by the $transfer operation; duplicate values would make a partial transfer ambiguous. |
entry.where(resource is ServiceRequest).select(resource.identifier.where(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PLAC').exists()).value).isDistinct()
|
| au-ereq-bundle-07 | error | Bundle | Every entry request method shall be POST or PUT. The bundle creates resources (POST, optionally with ifNoneExist) or conditionally updates them by identifier (PUT); read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted in a diagnostic request submission. |
entry.all(request.method = 'POST' or request.method = 'PUT')
|
This structure is derived from Bundle
Summary
Mandatory: 28 elements(18 nested mandatory elements)
Must-Support: 58 elements
Fixed: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | This is an abstract profile. Child profiles: AUeRequestingPathologyRequestBundle, AUeRequestingImagingRequestBundle Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, au-ereq-bundle-01, au-ereq-bundle-02, au-ereq-bundle-03, au-ereq-bundle-04, au-ereq-bundle-06, au-ereq-bundle-07 | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| type |
SOΣ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: transaction
| ||||||||
| Slices for entry |
SOΣC | 7..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource, profile:resource Constraints: bdl-5, bdl-8 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 | |||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| entry:patient |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPatient | A patient in the context of electronic exchange of health information | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| entry:requestingPractitioner |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPractitioner | A person with a formal responsibility in the provisioning of services | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| entry:requestingPractitionerRole |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| entry:organization |
SOΣC | 1..2 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingOrganization | An organisation in an Australian healthcare context | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| entry:serviceRequest |
SOΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingDiagnosticRequest | A service request in an Australian healthcare context | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:taskGroup |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingTaskGroup | A task to be performed | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:taskDiagnosticRequest |
SOΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingTaskDiagnosticRequest | A task to be performed | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:encounter |
SOΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingEncounter | An encounter in an Australian healthcare context | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:coverage |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingCoverage | Insurance or medical plan or a payment agreement | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:clinicalContextDocument |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingClinicalContextDocumentReference | A reference to a document | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:communicationRequest |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingCommunicationRequestCopyTo, AUeRequestingCommunicationRequestUrgentProvider, AUeRequestingCommunicationRequestPatient | A request for information to be sent to a receiver | |||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:supportingObservation |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
Σ | 1..1 | Observation | A resource in the bundle | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:location |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
Σ | 1..1 | Location | A resource in the bundle | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requestingPractitioner.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requestingPractitionerRole.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:serviceRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:taskGroup.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:taskDiagnosticRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:encounter.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:coverage.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:clinicalContextDocument.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:communicationRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:supportingObservation.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:location.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-ereq-bundle-01 | error | Bundle | The number of Task Diagnostic Request entries shall equal the number of ServiceRequest entries. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).count() = entry.where(resource is ServiceRequest).count()
|
| au-ereq-bundle-02 | error | Bundle | Every Task Diagnostic Request focus reference shall resolve to a ServiceRequest entry within the bundle. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.focus.reference in %resource.entry.fullUrl)
|
| au-ereq-bundle-03 | error | Bundle | Every Task Diagnostic Request partOf reference shall resolve to the Task Group entry within the bundle. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.partOf.reference in %resource.entry.where(resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-group').exists()).fullUrl)
|
| au-ereq-bundle-04 | error | Bundle | Every entry.fullUrl shall be a urn:uuid: value with a lowercase UUID. |
entry.all(fullUrl.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'))
|
| au-ereq-bundle-06 | error | Bundle | The placer identifier value shall be unique across all ServiceRequest entries in the bundle. The placer identifier (ServiceRequest.identifier slice 'placer', type PLAC) is the per-test handle used by the $transfer operation; duplicate values would make a partial transfer ambiguous. |
entry.where(resource is ServiceRequest).select(resource.identifier.where(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PLAC').exists()).value).isDistinct()
|
| au-ereq-bundle-07 | error | Bundle | Every entry request method shall be POST or PUT. The bundle creates resources (POST, optionally with ifNoneExist) or conditionally updates them by identifier (PUT); read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted in a diagnostic request submission. |
entry.all(request.method = 'POST' or request.method = 'PUT')
|
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | This is an abstract profile. Child profiles: AUeRequestingPathologyRequestBundle, AUeRequestingImagingRequestBundle Contains a collection of resources Constraints: au-ereq-bundle-01, au-ereq-bundle-02, au-ereq-bundle-03, au-ereq-bundle-04, au-ereq-bundle-06, au-ereq-bundle-07 | ||||||||
| type |
SO | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: transaction
| ||||||||
| Slices for entry |
SO | 7..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource, profile:resource
| ||||||||
| entry:All Slices |
Content/Rules for all slices | |||||||||||
| request |
||||||||||||
| method |
1..1 | code | POST | PUT (create or conditional update only) | |||||||||
| entry:patient |
SO | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPatient | A patient in the context of electronic exchange of health information | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST | PUT (create or conditional update only)
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SO | 0..1 | string | For conditional creates
| ||||||||
| entry:requestingPractitioner |
SO | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPractitioner | A person with a formal responsibility in the provisioning of services | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST | PUT (create or conditional update only)
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SO | 0..1 | string | For conditional creates
| ||||||||
| entry:requestingPractitionerRole |
SO | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST | PUT (create or conditional update only)
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SO | 0..1 | string | For conditional creates
| ||||||||
| entry:organization |
SO | 1..2 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingOrganization | An organisation in an Australian healthcare context | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST | PUT (create or conditional update only)
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneExist |
SO | 0..1 | string | For conditional creates
| ||||||||
| entry:serviceRequest |
SO | 1..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingDiagnosticRequest | A service request in an Australian healthcare context | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:taskGroup |
SO | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingTaskGroup | A task to be performed | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:taskDiagnosticRequest |
SO | 1..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingTaskDiagnosticRequest | A task to be performed | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:encounter |
SO | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingEncounter | An encounter in an Australian healthcare context | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:coverage |
SO | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingCoverage | Insurance or medical plan or a payment agreement | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:clinicalContextDocument |
SO | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingClinicalContextDocumentReference | A reference to a document | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:communicationRequest |
SO | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingCommunicationRequestCopyTo, AUeRequestingCommunicationRequestUrgentProvider, AUeRequestingCommunicationRequestPatient | A request for information to be sent to a receiver | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:supportingObservation |
SO | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | Observation | A resource in the bundle | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| entry:location |
SO | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||||||
| fullUrl |
SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | Location | A resource in the bundle | |||||||||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
| method |
SO | 1..1 | code | POST (create only) Fixed Value: POST
| ||||||||
| url |
SO | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| Documentation for this format | ||||||||||||
| Id | Grade | Path(s) | Description | Expression |
| au-ereq-bundle-01 | error | Bundle | The number of Task Diagnostic Request entries shall equal the number of ServiceRequest entries. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).count() = entry.where(resource is ServiceRequest).count()
|
| au-ereq-bundle-02 | error | Bundle | Every Task Diagnostic Request focus reference shall resolve to a ServiceRequest entry within the bundle. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.focus.reference in %resource.entry.fullUrl)
|
| au-ereq-bundle-03 | error | Bundle | Every Task Diagnostic Request partOf reference shall resolve to the Task Group entry within the bundle. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.partOf.reference in %resource.entry.where(resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-group').exists()).fullUrl)
|
| au-ereq-bundle-04 | error | Bundle | Every entry.fullUrl shall be a urn:uuid: value with a lowercase UUID. |
entry.all(fullUrl.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'))
|
| au-ereq-bundle-06 | error | Bundle | The placer identifier value shall be unique across all ServiceRequest entries in the bundle. The placer identifier (ServiceRequest.identifier slice 'placer', type PLAC) is the per-test handle used by the $transfer operation; duplicate values would make a partial transfer ambiguous. |
entry.where(resource is ServiceRequest).select(resource.identifier.where(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PLAC').exists()).value).isDistinct()
|
| au-ereq-bundle-07 | error | Bundle | Every entry request method shall be POST or PUT. The bundle creates resources (POST, optionally with ifNoneExist) or conditionally updates them by identifier (PUT); read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted in a diagnostic request submission. |
entry.all(request.method = 'POST' or request.method = 'PUT')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | This is an abstract profile. Child profiles: AUeRequestingPathologyRequestBundle, AUeRequestingImagingRequestBundle Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, au-ereq-bundle-01, au-ereq-bundle-02, au-ereq-bundle-03, au-ereq-bundle-04, au-ereq-bundle-06, au-ereq-bundle-07 | ||||||||
| 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): A human language.
| |||||||||
| identifier |
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||||||
| type |
SOΣ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: transaction
| ||||||||
| timestamp |
Σ | 0..1 | instant | When the bundle was assembled | ||||||||
| total |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||||||
| link |
Σ | 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 | ||||||||
| Slices for entry |
SOΣC | 7..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource, profile:resource Constraints: bdl-5, bdl-8 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 |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| resource |
Σ | 0..1 | Resource | A resource in the bundle | ||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
Σ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||||||
| url |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:patient |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPatient | A patient in the context of electronic exchange of health information | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:requestingPractitioner |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPractitioner | A person with a formal responsibility in the provisioning of services | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:requestingPractitionerRole |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingPractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:organization |
SOΣC | 1..2 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingOrganization | An organisation in an Australian healthcare context | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST | PUT (create or conditional update only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
SOΣ | 0..1 | string | For conditional creates
| ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:serviceRequest |
SOΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingDiagnosticRequest | A service request in an Australian healthcare context | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:taskGroup |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingTaskGroup | A task to be performed | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:taskDiagnosticRequest |
SOΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingTaskDiagnosticRequest | A task to be performed | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:encounter |
SOΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingEncounter | An encounter in an Australian healthcare context | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:coverage |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingCoverage | Insurance or medical plan or a payment agreement | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:clinicalContextDocument |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingClinicalContextDocumentReference | A reference to a document | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:communicationRequest |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
1..1 | AUeRequestingCommunicationRequestCopyTo, AUeRequestingCommunicationRequestUrgentProvider, AUeRequestingCommunicationRequestPatient | A request for information to be sent to a receiver | |||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:supportingObservation |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
Σ | 1..1 | Observation | A resource in the bundle | ||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| entry:location |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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..* | See link (Bundle) | Links related to this entry | ||||||||
| fullUrl |
SOΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
| ||||||||
| resource |
Σ | 1..1 | Location | A resource in the bundle | ||||||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||||||
| 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 | ||||||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||||||
| 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 | ||||||||
| method |
SOΣ | 1..1 | code | POST (create only) Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
| ||||||||
| url |
SOΣ | 1..1 | uri | URL for HTTP equivalent of this entry
| ||||||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||||||
| 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 | ||||||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||
| signature |
Σ | 0..1 | Signature | Digital Signature | ||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requestingPractitioner.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requestingPractitioner.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requestingPractitionerRole.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requestingPractitionerRole.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:serviceRequest.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:serviceRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:taskGroup.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:taskGroup.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:taskDiagnosticRequest.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:taskDiagnosticRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:encounter.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:encounter.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:coverage.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:coverage.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:clinicalContextDocument.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:clinicalContextDocument.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:communicationRequest.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:communicationRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:supportingObservation.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:supportingObservation.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:location.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:location.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-ereq-bundle-01 | error | Bundle | The number of Task Diagnostic Request entries shall equal the number of ServiceRequest entries. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).count() = entry.where(resource is ServiceRequest).count()
|
| au-ereq-bundle-02 | error | Bundle | Every Task Diagnostic Request focus reference shall resolve to a ServiceRequest entry within the bundle. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.focus.reference in %resource.entry.fullUrl)
|
| au-ereq-bundle-03 | error | Bundle | Every Task Diagnostic Request partOf reference shall resolve to the Task Group entry within the bundle. |
entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.partOf.reference in %resource.entry.where(resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-group').exists()).fullUrl)
|
| au-ereq-bundle-04 | error | Bundle | Every entry.fullUrl shall be a urn:uuid: value with a lowercase UUID. |
entry.all(fullUrl.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'))
|
| au-ereq-bundle-06 | error | Bundle | The placer identifier value shall be unique across all ServiceRequest entries in the bundle. The placer identifier (ServiceRequest.identifier slice 'placer', type PLAC) is the per-test handle used by the $transfer operation; duplicate values would make a partial transfer ambiguous. |
entry.where(resource is ServiceRequest).select(resource.identifier.where(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PLAC').exists()).value).isDistinct()
|
| au-ereq-bundle-07 | error | Bundle | Every entry request method shall be POST or PUT. The bundle creates resources (POST, optionally with ifNoneExist) or conditionally updates them by identifier (PUT); read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted in a diagnostic request submission. |
entry.all(request.method = 'POST' or request.method = 'PUT')
|
This structure is derived from Bundle
Summary
Mandatory: 28 elements(18 nested mandatory elements)
Must-Support: 58 elements
Fixed: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2024 HL7 Australia. Package hl7.fhir.au.ereq#1.0.1-ci-build based on FHIR 4.0.1. Generated 2026-08-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change