AU Core Implementation Guide
1.0.0-preview - Preview Australia flag

This page is part of the AU Core (v1.0.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

CapabilityStatement: AU Core Requester CapabilityStatement

Official URL: http://hl7.org.au/fhir/core/CapabilityStatement/au-core-requester Version: 1.0.0-preview
Standards status: Draft Maturity Level: 1 Computable Name: AUCoreRequesterCapabilityStatement

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 Requester actor that is responsible for creating and initiating the queries for information. The complete list of FHIR profiles, RESTful operations, and search parameters supported by AU Core Requesters 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 requester supports a particular resource.

Resource Type Profile Supported Target Reference
AllergyIngolerance AU Core AllergyIntolerance AU Core Patient
Condition AU Core Condition AU Core Patient
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 Base Related Person
Immunization AU Core Immunization AU Core Patient
Location AU Core Location AU Core Organization
Medication Medication -
Medication AU Core Medication -
MedicationRequest AU Core MedicationRequest AU Core Condition, AU Core Encounter, Medication, AU Core Medication, Observation, AU Core Organization, AU Core Patient, AU Core Practitioner, AU Core PractitionerRole, AU Base Related Person
Observation AU Core Blood Pressure AU Core Patient
Observation AU Core Body Height AU Core Patient
Observation AU Core Body Temperature AU Core Patient
Observation AU Core Body Weight 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 Base Related Person
Observation AU Core Heart Rate AU Core Patient
Observation Observation -
Observation AU Core Pathology Result Observation AU Core Organization, AU Core Pathology Result Observation, AU Core Patient, AU Core Practitioner, AU Core PractitionerRole, AU Base Related Person, AU Base Specimen
Observation AU Core Respiration Rate AU Core Patient
Observation AU Core Smoking Status AU Core Patient
Observation AU Core Waist Circumference AU Core Patient
Organization Organization -
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 Base Related Person -
Specimen AU Base Specimen -

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement au-core-requester

AU Core Requester CapabilityStatement

  • Implementation Guide Version: 1.0.0-preview
  • 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: client

The AU Core Requester 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. Support JSON source formats for all AU Core interactions.

The AU Core Requester 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.
  • MAY support the search-systeminteraction.
  • MAY support the history-systeminteraction.

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
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
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/StructureDefinition/au-relatedperson

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 requester supports the AllergyIntolerance resource, the requester 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 requester supports the Condition resource, the requester 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 DocumentReference

Base System Profile
DocumentReference
Profile Conformance
SHALL
Reference Policy

Interaction summary

    Documentation

    If the requester supports the DocumentReference resource, the requester 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 requester supports the Encounter resource, the requester 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 requester supports the Immunization resource, the requester 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 requester supports the Location resource, the requester 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 requester supports the Medication resource, the requester 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 requester supports the MedicationRequest resource, the requester 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 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.

    The requester SHOULD support the _include parameter for MedicationRequest:medication. The responder SHOULD support the _include parameter for MedicationRequest:medication.

    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 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 requester supports the Observation resource, the requester 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 requester supports the Organization resource, the requester 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

    Requesters SHALL be able to access the patient record using the following API call:

    GET [url]/Patient/[id]

    Requesters SHOULD use these search parameters that responders are required to support to access the patient record:

    • _id
    • identifier

    Requesters are not required to support any additional search parameters, and requesters SHOULD NOT expect responders to do so.

    The requester SHALL support the AU Core profile and SHALL support the conformance expectations for the Patient 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 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_idtoken

    The requester SHOULD support _id.

    The responder SHALL support _id.

    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 requester supports the Practitioner resource, the requester 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 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 requester supports the PractitionerRole resource, the requester 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 requester SHOULD support the _include parameter for PractitionerRole:practitioner. The responder 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 requester supports the Procedure resource, the requester 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 Base Related Person
    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary

      Documentation

      If the requester supports the RelatedPerson resource, the requester SHALL support the AU Base profile and the conformance expectations for the RelatedPerson resource.