AU Core Implementation Guide
0.4.0-preview - Preview
This page is part of the AU Core (v0.4.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org.au/fhir/core/CapabilityStatement/au-core-responder | Version: 0.4.0-preview | |||
Standards status: Draft | Maturity Level: 1 | Computable Name: AUCoreResponderCapabilityStatement | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
This CapabilityStatement describes the basic rules for the AU Core Responder actor that is responsible for providing responses to queries submitted by AU Core Requesters. The complete list of FHIR profiles, RESTful operations, and search parameters supported by AU Core Responders are defined in this CapabilityStatement.
Raw OpenAPI-Swagger Definition file | Download
json
, SHOULD support xml
application/json-patch+json
Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
server
The AU Core Responder SHALL:
Support the AU Core Patient resource profile.
Support at least one additional resource profile from the list of AU Core Profiles.
Implement the RESTful behavior according to the FHIR specification.
Return the following response classes:
(Status 400): Bad Request
(Status 401): Not Authorized
(Status 403): Forbidden
(Status 404): Not Found
Support JSON source formats for all AU Core interactions.
Declare a CapabilityStatement identifying the list of profiles, operations, and search parameters supported.
The AU Core Responder SHOULD:
- A responder MAY reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found"
- For authentication and authorisation, systems MAY support any SMART App Launch and SMART Backend Service Authorization. When this is not avalable, basic authentication MAY be used.
transaction
interaction.batch
interaction.search-system
interaction.history-system
interaction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
resolves
read
,search-type
.
create
,update
,delete
,vread
,patch
,history-instance
.
If the responder supports the AllergyIntolerance resource, the responder SHALL support the AU Core profile and the conformance expectations for the AllergyIntolerance resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient |
reference
|
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
SHOULD | patient.identifier |
reference.token
|
The requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
MAY | clinical-status |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
Conformance | Parameters | Types |
---|---|---|
SHOULD | patient+ clinical-status |
reference + token
|
resolves
read
,search-type
.
create
,update
,delete
,vread
,patch
,history-instance
.
If the responder supports the Condition resource, the responder SHALL support the AU Core profile and the conformance expectations for the Condition resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient |
reference
|
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
SHOULD | patient.identifier |
reference.token
|
The requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
MAY | category |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
MAY | clinical-status |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
MAY | code |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
MAY | onset-date |
date
|
The requester SHALL provide a value precise to the second + time offset. The responder SHALL support a value precise to the second + time offset. The requester SHALL support these search comparators The responder SHALL support these search comparators |
Conformance | Parameters | Types |
---|---|---|
SHALL | patient+ clinical-status |
reference + token
|
SHALL | patient+ category |
reference + token
|
SHOULD | patient+ category+ clinical-status |
reference + token + token
|
SHOULD | patient+ code |
reference + token
|
SHOULD | patient+ onset-date |
reference + date
|
resolves
read
,search-type
.
create
,update
,delete
,vread
,patch
,history-instance
.
If the responder supports the Encounter resource, the responder SHALL support the AU Core profile and the conformance expectations for the Encounter resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient |
reference
|
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
SHOULD | patient.identifier |
reference.token
|
The requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
MAY | class |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
MAY | date |
date
|
The requester SHALL provide a value precise to the second + time offset. The responder SHALL support a value precise to the second + time offset. The requester SHALL support these search comparators The responder SHALL support these search comparators |
MAY | identifier |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
MAY | location |
reference
|
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
MAY | status |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
resolves
read
,search-type
.
create
,update
,delete
,vread
,patch
,history-instance
.
If the responder supports the Immunization resource, the responder SHALL support the AU Core profile and the conformance expectations for the Immunization resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient |
reference
|
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
SHOULD | patient.identifier |
reference.token
|
The requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
MAY | date |
date
|
The requester SHALL provide a value precise to the second + time offset. The responder SHALL support a value precise to the second + time offset. The requester SHALL support these search comparators The responder SHALL support these search comparators |
MAY | status |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
MAY | vaccine-code |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
resolves
read
,search-type
.
create
,update
,delete
,vread
,patch
,history-instance
.
If the responder supports the Location resource, the responder SHALL support the AU Core profile and the conformance expectations for the Location resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | address |
string
|
|
SHALL | name |
string
|
|
SHOULD | address-city |
string
|
|
SHOULD | address-state |
string
|
|
SHOULD | address-postalcode |
string
|
|
MAY | identifier |
token
|
The requester SHALL provide at least a code value and SHOULD provide both the system and code values. The responder SHALL support both. |
resolves
read
.
search-type
,create
,update
,delete
,vread
,patch
,history-instance
.
MedicationAdministration, MedicationDispense, MedicationRequest, and MedicationStatement resources can represent a medication, using an external reference to a Medication resource. If the responder supports the Medication resource, the responder SHALL support the AU Core profile and the conformance expectations for the Medication resource.
resolves
read
,search-type
.
create
,update
,delete
,vread
,patch
,history-instance
.
If the responder supports the MedicationRequest resource, the responder SHALL support the AU Core profile and the conformance expectations for the MedicationRequest resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHOULD | _id |
token
|
|
SHALL | patient |
reference
|
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
SHOULD | patient.identifier |
reference.token
|
The requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
MAY | authoredon |
date
|
The requester SHALL provide a value precise to the second + time offset. The responder SHALL support a value precise to the second + time offset. The requester SHALL support these search comparators The responder SHALL support these search comparators |
MAY | intent |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
MAY | status |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
resolves
read
,search-type
.
create
,update
,delete
,vread
,patch
,history-instance
.
If the responder supports the Observation resource, the responder SHALL support the AU Core profile and the conformance expectations for the Observation resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient |
reference
|
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
SHOULD | patient.identifier |
reference.token
|
The requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
MAY | category |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
MAY | code |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
MAY | date |
date
|
The requester SHALL provide a value precise to the second + time offset. The responder SHALL support a value precise to the second + time offset. The requester SHALL support these search comparators The responder SHALL support these search comparators |
MAY | status |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
resolves
read
,search-type
.
create
,update
,delete
,vread
,patch
,history-instance
.
If the responder supports the Organization resource, the responder SHALL support the AU Core profile and the conformance expectations for the Organization resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier |
token
|
The requester SHALL provide at least a code value and SHOULD provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using HPI-O and ABN identifiers as defined in the profile. The responder SHOULD support search using HPI-O and ABN identifiers as defined in the profile. |
SHOULD | address |
string
|
|
SHOULD | name |
string
|
|
SHOULD | _id |
token
|
resolves
read
,search-type
.
create
,update
,delete
,vread
,patch
,history-instance
.
The responder SHALL support the Patient resource, the AU Core profile, and the conformance expectations for the Patient resource.
responders SHALL support the capability for a requester application to access the patient record using any of the following API calls:
GET [url]/Patient/[id]
GET [url]/Patient?_id=[id]
GET [url]/Patient?identifier=[identifier]
responders are not required to support any additional search parameters, and requesters SHOULD NOT expect responders to do so.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id |
token
|
|
SHALL | identifier |
token
|
The requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
SHOULD | name |
string
|
|
SHOULD | family |
string
|
|
MAY | birthdate |
date
|
The requester SHALL provide a value precise to the day offset. The responder SHALL support a value precise to the day offset. The requester SHALL support these search comparators The responder SHALL support these search comparators |
MAY | gender |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
MAY | indigenous-status |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
MAY | gender-identity |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
resolves
read
,search-type
.
create
,update
,delete
,vread
,patch
,history-instance
.
If the responder supports the Practitioner resource, the responder SHALL support the AU Core profile and the conformance expectations for the Practitioner resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier |
token
|
The requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using a HPI-I identifier as defined in the profile. The responder SHOULD support search using a HPI-I identifier as defined in the profile. |
SHOULD | name |
string
|
|
SHALL | _id |
token
|
resolves
read
,search-type
.
create
,update
,delete
,vread
,patch
,history-instance
.
If the responder supports the PractitionerRole resource, the responder SHALL support the AU Core profile and the conformance expectations for the PractitionerRole resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier |
token
|
The requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using a Medicare Provider Number identifier as defined in the profile. The responder SHOULD support search using a Medicare Provider Number identifier as defined in the profile. |
SHALL | practitioner |
reference
|
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
SHOULD | practitioner.identifier |
reference.token
|
The requester SHALL provide at least a code value and SHOULD provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using a HPI-I identifier as defined in the AU Core Practitioner profile. The responder SHOULD support search using a HPI-I identifier as defined in the AU Core Practitioner profile. |
SHOULD | _id |
token
|
|
SHOULD | specialty |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
MAY | organization |
reference
|
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
resolves
read
,search-type
.
create
,update
,delete
,vread
,patch
,history-instance
.
If the responder supports the Procedure resource, the responder SHALL support the AU Core profile and the conformance expectations for the Procedure resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient |
reference
|
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
SHOULD | patient.identifier |
reference.token
|
The requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
MAY | code |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
MAY | date |
date
|
The requester SHALL provide a value precise to the second + time offset. The responder SHALL support a value precise to the second + time offset. The requester SHALL support these search comparators The responder SHALL support these search comparators |
MAY | status |
token
|
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |