AU Core Implementation Guide
1.1.0-ci-build - CI Build Australia flag

AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/au-fhir-core/ and changes regularly. See the Directory of published versions

CapabilityStatement: AU Core Responder CapabilityStatement

Official URL: http://hl7.org.au/fhir/core/CapabilityStatement/au-core-responder Version: 1.1.0-ci-build
Standards status: Trial-use Maturity Level: 2 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.

Summary of Must Support and References Between Profiles

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.

Resource Type Profile Supported Target Reference
AllergyIntolerance AU Core AllergyIntolerance AU Core Patient
Condition AU Core Condition AU Core Patient
DiagnosticReport AU Base Diagnostic Report -
DocumentReference DocumentReference -
Encounter AU Core Encounter AU Core Condition, AU Core Location, Observation, AU Core Organization, AU Core Patient, AU Core Practitioner, AU Core PractitionerRole, AU Core Procedure, AU Core RelatedPerson
Immunization AU Core Immunization AU Core Patient
Location AU Core Location AU Core Organization
Medication AU Core Medication -
MedicationRequest AU Core MedicationRequest AU Core Condition, AU Core Encounter, AU Core Medication, Observation, AU Core Organization, AU Core Patient, AU Core Practitioner, AU Core PractitionerRole,AU Core RelatedPerson
MedicationStatement AU Core MedicationStatement AU Base Diagnostic Report, AU Core Condition, AU Core Medication, Observation, AU Core Patient
Observation AU Core Blood Pressure, AU Core Body Height, AU Core Body Temperature, AU Core Body Weight, AU Core Heart Rate, AU Core Respiration Rate, AU Core Smoking Status, AU Core Waist Circumference AU Core Patient
Observation AU Core Diagnostic Result Observation AU Core Diagnostic Result Observation, AU Core Organization, AU Core Pathology Result Observation, AU Core Patient, AU Core Practitioner, AU Core PractitionerRole,AU Core RelatedPerson
Observation AU Core Pathology Result Observation AU Core Organization, AU Core Pathology Result Observation, AU Core Patient, AU Core Practitioner, AU Core PractitionerRole,AU Core RelatedPerson, AU Base Specimen
Organization AU Core Organization -
Patient AU Core Patient -
Practitioner AU Core Practitioner -
PractitionerRole AU Core PractitionerRole AU Core Organization, AU Core Practitioner
Procedure AU Core Procedure AU Core Condition, DocumentReference, AU Core Encounter, Observation, AU Core Patient, AU Core Procedure
RelatedPerson AU Core RelatedPerson AU Core Patient
Specimen AU Base Specimen -

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement au-core-responder

AU Core Responder CapabilityStatement

  • Implementation Guide Version: 1.1.0-ci-build
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support json, SHOULD support xml
  • Supported Patch Formats: SHOULD support application/json-patch+json
  • Published on: 2023-05-15
  • Published by: HL7 Australia

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.

SHALL Support the Following Implementation Guides

SHOULD Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

The AU Core Responder SHALL:

  1. Support the AU Core Patient resource profile.

  2. Support at least one additional resource profile from the list of AU Core Profiles.

  3. Implement the RESTful behaviour according to the FHIR specification.

  4. Return the following response classes:

    • (Status 400): invalid parameter

    • (Status 401/4xx): unauthorized request

    • (Status 403): insufficient scope

    • (Status 404): unknown resource

  5. Support JSON source formats for all AU Core interactions.

  6. Declare a CapabilityStatement identifying the list of profiles, operations, and search parameters supported.

The AU Core Responder SHOULD:

  1. Support XML source formats for all AU Core interactions.
Security

See the Security and Privacy page for AU Core security requirements.

Summary of System-wide Interactions
  • MAY support the transactioninteraction.
  • MAY support the batchinteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
AllergyIntolerancehttp://hl7.org.au/fhir/core/StructureDefinition/au-core-allergyintoleranceyyclinical-status, patient, patient+clinical-status
Conditionhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-conditionyycategory, clinical-status, code, onset-date, patient, patient+category, patient+clinical-status, patient+category+clinical-status, patient+code, patient+onset-date
DiagnosticReporthttp://hl7.org.au/fhir/StructureDefinition/au-diagnosticreport
DocumentReferencehttp://hl7.org/fhir/StructureDefinition/DocumentReference
Encounterhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-encounteryyclass, date, location, status, patient, date+patient, class+patient, patient+location, patient+status
Immunizationhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-immunizationyydate, status, vaccine-code, patient, patient+status, patient+date, patient+vaccine-code
Locationhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-locationyyaddress, name, address-city, address-state, address-postalcode
Medicationhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationy
MedicationRequesthttp://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationrequestyy_id, authoredon, intent, status, patient, patient+intent, patient+intent+status, patient+status, patient+intent+authoredonMedicationRequest:medication
MedicationStatementhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationstatementyy_id, effective, status, patient, patient+status, patient+effectiveMedicationStatement:medication
ObservationSupported Profiles
  AU Core Body Weight
  AU Core Blood Pressure
  AU Core Body Height
  AU Core Pathology Result Observation
  AU Core Body Temperature
  AU Core Heart Rate
  AU Core Waist Circumference
  AU Core Respiration Rate
  AU Core Diagnostic Result Observation
  AU Core Smoking Status		yycategory, code, date, status, patient, patient+category, patient+category+date, patient+code, patient+category+status, patient+code+date
Organizationhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-organizationyyaddress, identifier, name, _id
Patienthttp://hl7.org.au/fhir/core/StructureDefinition/au-core-patientyy_id, birthdate, family, gender, indigenous-status, identifier, name, gender-identity, birthdate+family, birthdate+name, family+gender, gender+name
Practitionerhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioneryy_id, identifier, name
PractitionerRolehttp://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerroleyy_id, identifier, practitioner, specialty, role, organizationPractitionerRole:practitioner
Procedurehttp://hl7.org.au/fhir/core/StructureDefinition/au-core-procedureyycode, date, status, patient, patient+date, patient+code+date, patient+status
RelatedPersonhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedpersonyy_id, name, relationship, patient, patient+relationship, patient+name
Specimenhttp://hl7.org.au/fhir/StructureDefinition/au-specimen

Resource Conformance: SHOULD AllergyIntolerance

Base System Profile
AU Core AllergyIntolerance
Profile Conformance
SHALL
Reference Policy
resolves

Interaction summary
  • SHALL support read, search-type.

Documentation

If the responder supports the AllergyIntolerance resource, the responder SHALL support the AU Core profile and the conformance expectations for the AllergyIntolerance resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

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.

MAYclinical-statustoken

The requester SHALL provide at least a code value and MAY provide both the system and code values.

The responder SHALL support both.

Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+clinical-statusreference+token

Resource Conformance: SHOULD Condition

Base System Profile
AU Core Condition
Profile Conformance
SHALL
Reference Policy
resolves

Interaction summary
  • SHALL support read, search-type.

Documentation

If the responder supports the Condition resource, the responder SHALL support the AU Core profile and the conformance expectations for the Condition resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

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.

MAYcategorytoken

The requester SHALL provide at least a code value and MAY provide both the system and code values.

The responder SHALL support both.

MAYclinical-statustoken

The requester SHALL provide at least a code value and MAY provide both the system and code values.

The responder SHALL support both.

MAYcodetoken

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 multipleOr.

The responder SHOULD support multipleOr.

MAYonset-datedate

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 gt, lt, ge, le.

The responder SHALL support these search comparators gt, lt, ge, le.

The requester SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

The responder SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+categoryreference+token
SHALLpatient+clinical-statusreference+token
SHOULDpatient+category+clinical-statusreference+token+token
SHOULDpatient+codereference+token
SHOULDpatient+onset-datereference+date

Resource Conformance: SHOULD DiagnosticReport

Base System Profile
AU Base Diagnostic Report
Profile Conformance
SHALL
Reference Policy

Interaction summary

    Documentation

    If the responder supports the DiagnosticReport resource, the responder SHALL support the AU Base profile and the conformance expectations for the DiagnosticReport resource.

    Resource Conformance: SHOULD DocumentReference

    Base System Profile
    DocumentReference
    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary

      Documentation

      If the responder supports the DocumentReference resource, the responder SHALL support the conformance expectations for the DocumentReference resource.

      Resource Conformance: SHOULD Encounter

      Base System Profile
      AU Core Encounter
      Profile Conformance
      SHALL
      Reference Policy
      resolves

      Interaction summary
      • SHALL support read, search-type.

      Documentation

      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 using Encounter.reasonReference. Although both Encounter.reasonCode and Encounter.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.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLpatientreference

      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.

      MAYclasstoken

      The requester SHALL provide at least a code value and MAY provide both the system and code values.

      The responder SHALL support both.

      MAYdatedate

      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 gt, lt, ge, le.

      The responder SHALL support these search comparators gt, lt, ge, le.

      The requester SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      The responder SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      MAYlocationreference

      The requester SHALL provide at least an id value and MAY provide both the Type and id values.

      The responder SHALL support both.

      MAYstatustoken

      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 multipleOr.

      The responder SHALL support multipleOr.

      Combined Search Parameters
      ConformanceParametersTypes
      SHALLdate+patientdate+reference
      SHOULDclass+patienttoken+reference
      SHOULDpatient+locationreference+reference
      SHOULDpatient+statusreference+token

      Resource Conformance: SHOULD Immunization

      Base System Profile
      AU Core Immunization
      Profile Conformance
      SHALL
      Reference Policy
      resolves

      Interaction summary
      • SHALL support read, search-type.

      Documentation

      If the responder supports the Immunization resource, the responder SHALL support the AU Core profile and the conformance expectations for the Immunization resource.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLpatientreference

      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.

      MAYdatedate

      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 gt, lt, ge, le.

      The responder SHALL support these search comparators gt, lt, ge, le.

      The requester SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      The responder SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      MAYstatustoken

      The requester SHALL provide at least a code value and MAY provide both the system and code values.

      The responder SHALL support both.

      MAYvaccine-codetoken

      The requester SHALL provide at least a code value and MAY provide both the system and code values.

      The responder SHALL support both.

      Combined Search Parameters
      ConformanceParametersTypes
      SHALLpatient+statusreference+token
      SHOULDpatient+datereference+date
      MAYpatient+vaccine-codereference+token

      Resource Conformance: SHOULD Location

      Base System Profile
      AU Core Location
      Profile Conformance
      SHALL
      Reference Policy
      resolves

      Interaction summary
      • SHALL support read, search-type.

      Documentation

      If the responder supports the Location resource, the responder SHALL support the AU Core profile and the conformance expectations for the Location resource.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLnamestring
      SHOULDaddressstring
      SHOULDaddress-citystring
      SHOULDaddress-statestring
      SHOULDaddress-postalcodestring
       

      Resource Conformance: SHOULD Medication

      Base System Profile
      AU Core Medication
      Profile Conformance
      SHALL
      Reference Policy
      resolves

      Interaction summary
      • SHALL support read.

      Documentation

      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.

      Resource Conformance: SHOULD MedicationRequest

      Base System Profile
      AU Core MedicationRequest
      Profile Conformance
      SHALL
      Reference Policy
      resolves

      Interaction summary
      • SHALL support read, search-type.

      Documentation

      If the responder supports the MedicationRequest resource, the responder SHALL support the AU Core profile and the conformance expectations for the MedicationRequest resource.

      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.

      The responder SHOULD support the _include parameter for MedicationRequest:medication, but where a responder references external Medication resources the responder SHALL support the _include parameter. The requester SHOULD support the _include parameter for MedicationRequest:medication.

      The MedicationRequest resource can communicate the clinical indication using either a code in MedicationRequest.reasonCode or a reference using MedicationRequest.reasonReference. Although both MedicationRequest.reasonCode and MedicationRequest.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.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLpatientreference

      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_idtoken
      MAYauthoredondate

      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 gt, lt, ge, le.

      The responder SHALL support these search comparators gt, lt, ge, le.

      The requester SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      The responder SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      MAYintenttoken

      The requester SHALL provide at least a code value and MAY provide both the system and code values.

      The responder SHALL support both.

      MAYstatustoken

      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 multipleOr.

      The responder SHALL support multipleOr.

      Combined Search Parameters
      ConformanceParametersTypes
      SHALLpatient+statusreference+token
      SHOULDpatient+intentreference+token
      SHOULDpatient+intent+statusreference+token+token
      SHOULDpatient+intent+authoredonreference+token+date

      Resource Conformance: SHOULD MedicationStatement

      Base System Profile
      AU Core MedicationStatement
      Profile Conformance
      SHALL
      Reference Policy
      resolves

      Interaction summary
      • SHALL support read, search-type.

      Documentation

      If the responder supports the MedicationStatement resource, the responder SHALL support the AU Core profile and the conformance expectations for the MedicationStatement resource.

      MedicationStatement 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.

      The responder SHOULD support the _include parameter for MedicationStatement:medication, but where a responder references external Medication resources the responder SHALL support the _include parameter. The requester SHOULD support the _include parameter for MedicationStatement:medication.

      The MedicationStatement resource can communicate the clinical indication using either a code in MedicationStatement.reasonCode or a reference using MedicationStatement.reasonReference. Although both MedicationStatement.reasonCode and MedicationStatement.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.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLpatientreference

      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_idtoken
      MAYeffectivedate

      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 gt, lt, ge, le.

      The responder SHALL support these search comparators gt, lt, ge, le.

      The requester SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      The responder SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      MAYstatustoken

      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 multipleOr.

      The responder SHALL support multipleOr.

      Combined Search Parameters
      ConformanceParametersTypes
      SHALLpatient+statusreference+token
      SHOULDpatient+effectivereference+date

      Resource Conformance: SHOULD Observation

      Core FHIR Resource
      Observation
      Reference Policy
      resolves
      Interaction summary
      • SHALL support read, search-type.

      Supported Profiles

      AU Core Body Weight
      AU Core Blood Pressure
      AU Core Body Height
      AU Core Pathology Result Observation
      AU Core Body Temperature
      AU Core Heart Rate
      AU Core Waist Circumference
      AU Core Respiration Rate
      AU Core Diagnostic Result Observation
      AU Core Smoking Status

      Documentation

      If the responder supports the Observation resource, the responder SHALL support the AU Core profiles and the conformance expectations for the Observation resource.

      Search Parameters
      ConformanceParameterTypeDocumentation
      MAYcategorytoken

      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.

      MAYcodetoken

      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 multipleOr.

      The responder SHALL support multipleOr.

      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.

      MAYdatedate

      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 gt, lt, ge, le.

      The responder SHALL support these search comparators gt, lt, ge, le.

      The requester SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      The responder SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      MAYstatustoken

      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 multipleOr.

      The responder SHALL support multipleOr.

      MAYpatientreference

      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.

      Combined Search Parameters
      ConformanceParametersTypes
      SHALLpatient+categoryreference+token
      SHALLpatient+category+datereference+token+date
      SHALLpatient+codereference+token
      SHOULDpatient+category+statusreference+token+token
      SHOULDpatient+code+datereference+token+date

      Resource Conformance: SHOULD Organization

      Base System Profile
      AU Core Organization
      Profile Conformance
      SHALL
      Reference Policy
      resolves

      Interaction summary
      • SHALL support read, search-type.

      Documentation

      If the responder supports the Organization resource, the responder SHALL support the AU Core profile and the conformance expectations for the Organization resource.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLidentifiertoken

      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.

      SHALLnamestring
      SHOULDaddressstring
      SHOULD_idtoken
       

      Resource Conformance: SHALL Patient

      Base System Profile
      AU Core Patient
      Profile Conformance
      SHALL
      Reference Policy
      resolves

      Interaction summary
      • SHALL support read, search-type.

      Documentation

      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.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALL_idtoken

      The requester SHOULD support _id.

      The responder SHALL support _id.

      SHALLidentifiertoken

      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.

      SHOULDfamilystring
      SHOULDnamestring
      MAYbirthdatedate

      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 gt, lt, ge, le.

      The responder SHOULD support these search comparators gt, lt, ge, le.

      The requester SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      The responder SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      MAYgendertoken

      The requester SHALL provide at least a code value and MAY provide both the system and code values.

      The responder SHALL support both.

      MAYindigenous-statustoken

      The requester SHALL provide at least a code value and MAY provide both the system and code values.

      The responder SHALL support both.

      MAYgender-identitytoken

      The requester SHALL provide at least a code value and MAY provide both the system and code values.

      The responder SHALL support both.

      Combined Search Parameters
      ConformanceParametersTypes
      SHOULDbirthdate+familydate+string
      SHOULDbirthdate+namedate+string
      SHOULDfamily+genderstring+token
      SHOULDgender+nametoken+string

      Resource Conformance: SHOULD Practitioner

      Base System Profile
      AU Core Practitioner
      Profile Conformance
      SHALL
      Reference Policy
      resolves

      Interaction summary
      • SHALL support read, search-type.

      Documentation

      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.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLidentifiertoken

      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_idtoken
      SHOULDnamestring
       

      Resource Conformance: SHOULD PractitionerRole

      Base System Profile
      AU Core PractitionerRole
      Profile Conformance
      SHALL
      Reference Policy
      resolves

      Interaction summary
      • SHALL support read, search-type.

      Documentation

      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.

      The responder SHOULD support the _include parameter for PractitionerRole:practitioner. The requester SHOULD support the _include parameter for PractitionerRole:practitioner.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLidentifiertoken

      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.

      SHALLpractitionerreference

      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_idtoken
      SHOULDspecialtytoken

      The requester SHALL provide at least a code value and MAY provide both the system and code values.

      The responder SHALL support both.

      SHOULDroletoken

      The requester SHALL provide at least a code value and MAY provide both the system and code values.

      The responder SHALL support both.

      MAYorganizationreference

      The requester SHALL provide at least an id value and MAY provide both the Type and id values.

      The responder SHALL support both.

       

      Resource Conformance: SHOULD Procedure

      Base System Profile
      AU Core Procedure
      Profile Conformance
      SHALL
      Reference Policy
      resolves

      Interaction summary
      • SHALL support read, search-type.

      Documentation

      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 using Procedure.reasonReference. Although both Procedure.reasonCode and Procedure.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.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLpatientreference

      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.

      MAYcodetoken

      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 multipleOr.

      The responder SHOULD support multipleOr.

      MAYdatedate

      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 gt, lt, ge, le.

      The responder SHALL support these search comparators gt, lt, ge, le.

      The requester SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      The responder SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.

      MAYstatustoken

      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 multipleOr.

      The responder SHALL support multipleOr.

      Combined Search Parameters
      ConformanceParametersTypes
      SHALLpatient+datereference+date
      SHOULDpatient+code+datereference+token+date
      SHOULDpatient+statusreference+token

      Resource Conformance: SHOULD RelatedPerson

      Base System Profile
      AU Core RelatedPerson
      Profile Conformance
      SHALL
      Reference Policy
      resolves

      Interaction summary
      • SHALL support read, search-type.

      Documentation

      If the responder supports the RelatedPerson resource, the responder SHALL support the AU Core profile and the conformance expectations for the RelatedPerson resource.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLpatientreference

      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_idtoken
      MAYnamestring
      MAYrelationshiptoken

      The requester SHALL provide both the system and code values.

      The responder SHALL support both.

      Combined Search Parameters
      ConformanceParametersTypes
      SHOULDpatient+relationshipreference+token
      SHOULDpatient+namereference+string

      Resource Conformance: SHOULD Specimen

      Base System Profile
      AU Base Specimen
      Profile Conformance
      SHALL
      Reference Policy

      Interaction summary

        Documentation

        If the responder supports the Specimen resource, the responder SHALL support the AU Base profile and the conformance expectations for the Specimen resource.