AU Core Implementation Guide
1.0.0-ci-build - CI Build
AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.0-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-core/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au/fhir/core/CapabilityStatement/au-core-responder | Version: 1.0.0-ci-build | |||
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.
The table below identifies where a Profile has a Must Support reference to other profiles or resources (i.e., Target Profiles). This list is provided to clarify where additional profiles or resources may need to be supported if a responder supports a particular resource.
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement au-core-responder
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 behaviour according to the FHIR specification.
Return the following response classes:
(Status 400): invalid parameter
(Status 401/4xx): unauthorized request
(Status 403): insufficient scope
(Status 404): unknown resource
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:
See the Security and Privacy page for AU Core security requirements.
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
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. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier 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 |
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. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier 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. The requester SHOULD support The responder SHOULD support |
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 The requester SHOULD support The responder SHOULD support |
Conformance | Parameters | Types |
---|---|---|
SHALL | patient+category | reference +token |
SHALL | patient+clinical-status | reference +token |
SHOULD | patient+category+clinical-status | reference +token +token |
SHOULD | patient+code | reference +token |
SHOULD | patient+onset-date | reference +date |
If the responder supports the DocumentReference resource, the responder SHALL support the conformance expectations for the DocumentReference resource.
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.
The Encounter resource can communicate the clinical indication using either a code in
Encounter.reasonCode
or a reference usingEncounter.reasonReference
. Although bothEncounter.reasonCode
andEncounter.reasonReference
are marked as Must Support, a responder is not required to support both but SHALL support at least one of these elements. The requester SHALL support both elements.
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. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier 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 The requester SHOULD support The responder SHOULD support |
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. The requester SHALL support The responder SHALL support |
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. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier 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 The requester SHOULD support The responder SHOULD support |
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. |
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 | name | string | |
SHOULD | address | string | |
SHOULD | address-city | string | |
SHOULD | address-state | string | |
SHOULD | address-postalcode | string | |
MAY | identifier | token | The requester SHALL provide both the system and code values. The responder SHALL support both. |
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.
read
, search-type
.create
, update
, delete
, vread
, patch
, history-instance
.MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be contained or an external resource. The responder MAY choose any one way or more than one method, but if an external reference to Medication is used, the responder SHALL support the
_include
parameter for searching this element. The requester application SHALL support all methods.If the responder supports the MedicationRequest resource, the responder SHALL support the AU Core profile and the conformance expectations for the MedicationRequest resource.
The MedicationRequest resource can communicate the clinical indication using either a code in
MedicationRequest.reasonCode
or a reference usingMedicationRequest.reasonReference
. Although bothMedicationRequest.reasonCode
andMedicationRequest.reasonReference
are marked as Must Support, a responder is not required to support both but SHALL support at least one of these elements. The requester SHALL support both elements.
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. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
SHOULD | _id | token | |
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 The requester SHOULD support The responder SHOULD support |
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. The requester SHALL support The responder SHALL support |
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 profiles and the conformance expectations for the Observation resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
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. The requester SHALL support search using the category code defined in each profile supported. The responder SHALL support search using the category code defined in each profile supported. |
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. The requester SHALL support The responder SHALL support The requester SHALL support search using the LOINC codes defined in each profile supported. The responder SHALL support search using the LOINC codes defined in each profile supported. |
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 The requester SHOULD support The responder SHOULD support |
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. The requester SHALL support The responder SHALL support |
MAY | 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. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
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 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 the using HPI-O and ABN identifiers as defined in the profile. |
SHALL | name | string | |
SHOULD | address | string | |
SHOULD | _id | token |
read
, search-type
.create
, update
, delete
, vread
, patch
, history-instance
.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.
The responder SHALL support the AU Core profile and SHALL support the conformance expectations for the Patient resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | The requester SHOULD support The responder SHALL support |
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 profile. The responder SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the profile. |
SHOULD | family | string | |
SHOULD | name | string | |
MAY | birthdate | date | The requester SHALL provide a value precise to the day. The responder SHALL support a value a value precise to the day. The requester SHOULD support these search comparators The responder SHOULD support these search comparators The requester SHOULD support The responder SHOULD support |
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. |
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.
Servers that support only the Practitioner resource SHALL provide implementation specific guidance how to access a provider’s location and contact information using only 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 the using a HPI-I identifier as defined in the profile. |
SHOULD | _id | token | |
SHOULD | name | string |
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.
Even though AU Core Profiles allow both PractitionerRole and Practitioner to be referenced, because PractitionerRole supplies a provider’s location, contact information, and reference to the Practitioner, it SHOULD be referenced instead of 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 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. The requester SHOULD support chained search practitioner.identifier using a HPI-I identifier as defined in the AU Core Practitioner profile. The responder SHOULD support chained search practitioner.identifier 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. |
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.
The Procedure resource can communicate the clinical indication using either a code in
Procedure.reasonCode
or a reference usingProcedure.reasonReference
. Although bothProcedure.reasonCode
andProcedure.reasonReference
are marked as Must Support, a responder is not required to support both but SHALL support at least one of these elements. The requester SHALL support both elements.
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. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier 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. The requester SHOULD support The responder SHOULD support |
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 The requester SHOULD support The responder SHOULD support |
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. The requester SHALL support The responder SHALL support |
If the responder supports the RelatedPerson resource, the responder SHALL support the AU Base profile and the conformance expectations for the RelatedPerson resource.