Generated Narrative: CapabilityStatement au-core-responder AU Core Responder CapabilityStatement Implementation Guide Version: 2.0.1-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 http://hl7.org.au/fhir/ImplementationGuide/hl7.fhir.au.base SHOULD Support the Following Implementation Guides http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch|2.2.0 http://hl7.org/fhir/uv/ipa/ImplementationGuide/hl7.fhir.uv.ipa FHIR RESTful Capabilities Mode: 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 standard. 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: 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 Type Profile R S U C Searches _include _revinclude Operations AllergyIntolerance http://hl7.org.au/fhir/core/StructureDefinition/au-core-allergyintolerance Y Y clinical-status, patient, patient+clinical-status CareTeam http://hl7.org/fhir/StructureDefinition/CareTeam Condition http://hl7.org.au/fhir/core/StructureDefinition/au-core-condition Y Y category, clinical-status, code, onset-date, patient, patient+category, patient+clinical-status, patient+category+clinical-status, patient+code, patient+onset-date DiagnosticReport http://hl7.org.au/fhir/core/StructureDefinition/au-core-diagnosticreport Y Y _id, patient, identifier, category, code, date, status, patient+category, patient+category+date, patient+category+status, patient+code, patient+status, patient+code+date DocumentReference http://hl7.org/fhir/StructureDefinition/DocumentReference Encounter http://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter Y Y class, date, location, status, patient, date+patient, class+patient, patient+location, patient+status HealthcareService http://hl7.org.au/fhir/core/StructureDefinition/au-core-healthcareservice Y Y name, identifier, _id, service-type Immunization http://hl7.org.au/fhir/core/StructureDefinition/au-core-immunization Y Y date, status, vaccine-code, patient, patient+status, patient+date, patient+vaccine-code Location http://hl7.org.au/fhir/core/StructureDefinition/au-core-location Y Y address, name, address-city, address-state, address-postalcode Medication http://hl7.org.au/fhir/core/StructureDefinition/au-core-medication Y MedicationRequest http://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationrequest Y Y _id, authoredon, intent, status, patient, patient+intent, patient+intent+status, patient+status, patient+intent+authoredon MedicationRequest:medication MedicationStatement http://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationstatement Y Y _id, effective, status, patient, patient+status, patient+effective MedicationStatement:medication Observation 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 AU Base Diagnostic Imaging Result Y Y category, code, date, status, patient, patient+category, patient+category+date, patient+code, patient+category+status, patient+code+date Organization http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization Y Y address, identifier, name, _id Patient http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient Y Y _id, birthdate, family, gender, indigenous-status, identifier, name, gender-identity, birthdate+family, birthdate+name, family+gender, gender+name Practitioner http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner Y Y _id, identifier, name PractitionerRole http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole Y Y _id, identifier, practitioner, specialty, role, organization PractitionerRole:practitioner Procedure http://hl7.org.au/fhir/core/StructureDefinition/au-core-procedure Y Y code, date, status, patient, patient+date, patient+code+date, patient+status RelatedPerson http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson Y Y _id, name, relationship, patient, patient+relationship, patient+name Specimen http://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 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. Combined Search Parameters Conformance Parameters Types SHOULD patient+clinical-status reference+token Resource Conformance: SHOULD CareTeam Base System Profile CareTeam Profile Conformance SHALL Reference Policy Interaction summary Documentation If the requester supports the CareTeam resource, the requester SHALL support the conformance expectations for the CareTeam resource. 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 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 multipleOr. The responder SHOULD support multipleOr. 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 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 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 Resource Conformance: SHOULD DiagnosticReport Base System Profile AU Core DiagnosticReport Profile Conformance SHALL Reference Policy resolves Interaction summary SHALL support read, search-type. Documentation If the responder supports the DiagnosticReport resource, the responder SHALL support the AU Core profile and the conformance expectations for the DiagnosticReport resource. Search Parameters Conformance Parameter Type Documentation SHALL _id token SHALL patient reference The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. 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 identifier token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. MAY category token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. MAY code token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. MAY date date The requester SHALL provide a value precise to the second + time offset. The responder SHALL support a value precise to the second + time offset. The requester SHALL support these search comparators 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. 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. Combined Search Parameters Conformance Parameters Types SHALL patient+category reference+token SHALL patient+category+date reference+token+date SHOULD patient+category+status reference+token+token SHOULD patient+code reference+token SHOULD patient+status reference+token SHOULD patient+code+date reference+token+date 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 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 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. 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 multipleOr. The responder SHALL support multipleOr. Combined Search Parameters Conformance Parameters Types SHALL date+patient date+reference SHOULD class+patient token+reference SHOULD patient+location reference+reference SHOULD patient+status reference+token Resource Conformance: SHOULD HealthcareService Base System Profile AU Core HealthcareService Profile Conformance SHALL Reference Policy resolves Interaction summary SHALL support read, search-type. Documentation If the responder supports the HealthcareService resource, the responder SHALL support the AU Core profile and the conformance expectations for the HealthcareService resource. Search Parameters Conformance Parameter Type Documentation SHALL name string SHOULD identifier token The requester SHALL provide both the system and code values. The responder SHALL support both. SHOULD _id token SHOULD service-type token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. 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 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 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. 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. Combined Search Parameters Conformance Parameters Types SHALL patient+status reference+token SHOULD patient+date reference+date MAY patient+vaccine-code reference+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 Conformance Parameter Type Documentation SHALL name string SHOULD address string SHOULD address-city string SHOULD address-state string SHOULD address-postalcode string 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 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 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. 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 multipleOr. The responder SHALL support multipleOr. Combined Search Parameters Conformance Parameters Types SHALL patient+status reference+token SHOULD patient+intent reference+token SHOULD patient+intent+status reference+token+token SHOULD patient+intent+authoredon reference+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 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 effective 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 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. 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 multipleOr. The responder SHALL support multipleOr. Combined Search Parameters Conformance Parameters Types SHALL patient+status reference+token SHOULD patient+effective reference+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 AU Base Diagnostic Imaging Result Documentation If the responder supports the Observation resource, the responder SHALL support the AU Core and AU Base profiles and the conformance expectations for the Observation resource. Search Parameters 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 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. 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 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. 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 multipleOr. The responder SHALL support multipleOr. 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. Combined Search Parameters Conformance Parameters Types SHALL patient+category reference+token SHALL patient+category+date reference+token+date SHALL patient+code reference+token SHOULD patient+category+status reference+token+token SHOULD patient+code+date reference+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 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 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 Conformance Parameter Type Documentation SHALL _id token The requester SHOULD support _id. The responder SHALL support _id. 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 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. 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. Combined Search Parameters Conformance Parameters Types SHOULD birthdate+family date+string SHOULD birthdate+name date+string SHOULD family+gender string+token SHOULD gender+name token+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 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 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 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. SHOULD role 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. 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 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 multipleOr. The responder SHOULD support multipleOr. 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 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. 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 multipleOr. The responder SHALL support multipleOr. Combined Search Parameters Conformance Parameters Types SHALL patient+date reference+date SHOULD patient+code+date reference+token+date SHOULD patient+status reference+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 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 name string MAY relationship token The requester SHALL provide both the system and code values. The responder SHALL support both. Combined Search Parameters Conformance Parameters Types SHOULD patient+relationship reference+token SHOULD patient+name reference+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.
This CapabilityStatement describes the basic rules for the [AU Core Responder actor](ActorDefinition-au-core-actor-responder.html) 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.
Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.
The AU Core Responder **SHALL**: 1. Support the AU Core Patient resource profile. 1. Support at least one additional resource profile from the list of AU Core Profiles. 1. Implement the RESTful behaviour according to the FHIR standard. 1. Return the following response classes: - (Status 400): invalid parameter - (Status 401/4xx): unauthorized request - (Status 403): insufficient scope - (Status 404): unknown resource 1. Support JSON source formats for all AU Core interactions. 1. 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.
See the [Security and Privacy](security.html) page for AU Core security requirements.
If the responder supports the AllergyIntolerance resource, the responder **SHALL** support the AU Core profile and the conformance expectations for the AllergyIntolerance resource.
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** 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.
If the requester supports the CareTeam resource, the requester **SHALL** support the conformance expectations for the CareTeam resource.
If the responder supports the Condition resource, the responder **SHALL** support the AU Core profile and the conformance expectations for the Condition resource.
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`.
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`.
If the responder supports the DiagnosticReport resource, the responder **SHALL** support the AU Core profile and the conformance expectations for the DiagnosticReport resource.
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`.
If the responder supports the DocumentReference resource, the responder **SHALL** support the conformance expectations for the DocumentReference resource.
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.
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 **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`.
If the responder supports the HealthcareService resource, the responder **SHALL** support the AU Core profile and the conformance expectations for the HealthcareService resource.
The requester **SHALL** provide both the system and code values. The responder **SHALL** support both.
If the responder supports the Immunization resource, the responder **SHALL** support the AU Core profile and the conformance expectations for the Immunization resource.
If the responder supports the Location resource, the responder **SHALL** support the AU Core profile and the conformance expectations for the Location resource.
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.
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](http://hl7.org/fhir/R4/references.html#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.
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](http://hl7.org/fhir/R4/references.html#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.
If the responder supports the Observation resource, the responder **SHALL** support the AU Core and AU Base profiles and the conformance expectations for the Observation resource.
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.
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.
If the responder supports the Organization resource, the responder **SHALL** support the AU Core profile and the conformance expectations for the Organization resource.
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.
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.
The requester **SHOULD** support `_id`. The responder **SHALL** support `_id`.
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`.
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.
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.
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.
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`.
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.
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.
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.
If the responder supports the RelatedPerson resource, the responder **SHALL** support the AU Core profile and the conformance expectations for the RelatedPerson resource.
If the responder supports the Specimen resource, the responder **SHALL** support the AU Base profile and the conformance expectations for the Specimen resource.