json
, SHOULD support xml
\n application/json-patch+json
\n This CapabilityStatement is under development; the list of profiles and search parameters matches the current draft, RESTful operation definition is not yet available.
\n\n\n\n Note to Implementers: FHIR Capabilities\n
\nAny 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.
\n
client
\n The AU Core Client SHALL:\n
\nSupport the AU Core Patient resource profile.
\nSupport at least one additional resource profile from the list of AU Core Profiles.
\nImplement the RESTful behavior according to the FHIR specification.
\nSupport JSON source formats for all AU Core interactions.
\nThe AU Core Client SHOULD:\n
\n\n\n\n\n\n
\n- TBD.
\n
transaction
interaction.batch
interaction.search-system
interaction.history-system
interaction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
\n_include
\n_revinclude
\n\nResource Type\n | \n\nProfile\n | \n\nR\n | \n\nS\n | \n\nU\n | \n\nC\n | \n\nSearches\n | \n\n\n_include\n \n | \n\n\n_revinclude\n \n | \n\nOperations\n | \n
---|---|---|---|---|---|---|---|---|---|
\nAllergyIntolerance\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-allergyintolerance\n | \ny | \ny | \n\n | \n | clinical-status, patient, patient.identifier, patient+clinical-status | \n\n | \nProvenance:target \n | \n\n |
\nBodyStructure\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-bodystructure\n | \ny | \ny | \n\n | \n | \n | \n | \n | \n |
\nCarePlan\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-careplan\n | \ny | \ny | \n\n | \n | category, date, patient, patient.identifier, patient+category, patient+category+date, patient+category+status, patient+category+status+date, status | \n\n | \nProvenance:target \n | \n\n |
\nCareTeam\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-careteam\n | \ny | \ny | \n\n | \n | patient, patient.identifier, patient+status, status | \n\n | \nProvenance:target \n | \n\n |
\nComposition\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-documentcomposition\n | \ny | \ny | \n\n | \n | _id, category, date, identifier, patient, patient.identifier, patient+category, patient+category+date, patient+category+status, patient+status, patient+type, patient+type+date, status, type | \n\n | \nProvenance:target \n | \n\n |
\nCondition\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-condition\n | \ny | \ny | \n\n | \n | category, clinical-status, code, onset-date, patient, patient.identifier, patient+category, patient+category+clinical-status, patient+clinical-status, patient+code, patient+onset-date | \n\n | \nProvenance:target \n | \n\n |
\nCoverage\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-coverage\n | \ny | \ny | \n\n | \n | identifier, patient, patient.identifier, patient+status, patient+type, status, type | \n\n | \nProvenance:target \n | \n\n |
\nDevice\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-device-system\n | \ny | \ny | \n\n | \n | _id, identifier, type | \n\n | \nProvenance:target \n | \n\n |
\nDiagnosticReport\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-diagnosticreport\n | \ny | \ny | \n\n | \n | _id, category, code, date, identifier, patient, patient.identifier, patient+category, patient+category+date, patient+category+status, patient+code, patient+code+date, patient+status, status | \n\n | \nProvenance:target \n | \n\n |
\nDocumentReference\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-documentreference\n | \ny | \ny | \n\n | \n | _id, category, contenttype, date, identifier, patient, patient.identifier, patient+category, patient+category+date, patient+category+status, patient+contenttype, patient+status, patient+type, patient+type+date, status, type | \n\n | \nProvenance:target \n | \n\n |
\nEncounter\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter\n | \ny | \ny | \n\n | \n | class, date, discharge-disposition, identifier, location, patient, patient.identifier, patient+class, patient+date, patient+discharge-disposition, patient+location, patient+status, patient+type, status, type | \n\n | \nProvenance:target \n | \n\n |
\nHealthcareService\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-healthcareservice\n | \ny | \ny | \n\n | \n | identifier, location, name, organization, service-category, service-type, specialty | \n\n | \nProvenance:target \n | \n\n |
\nImmunization\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-immunization\n | \ny | \ny | \n\n | \n | date, patient, patient.identifier, patient+date, patient+status, patient+vaccine-code, status, vaccine-code | \n\n | \nProvenance:target \n | \n\n |
\nList\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-list\n | \ny | \ny | \n\n | \n | _id, code, date, encounter, identifier, patient, patient.identifier, patient+code, patient+code+date, patient+status, status | \n\n | \nProvenance:target \n | \n\n |
\nLocation\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-location\n | \ny | \ny | \n\n | \n | address, address-city, address-postalcode, address-state, identifier, name | \n\n | \nProvenance:target \n | \n\n |
\nMedication\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-medication\n | \ny | \n\n | \n | \n | \n | \n | \n | \n |
\nMedicationAdministration\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationadministration\n | \ny | \ny | \n\n | \n | effective-time, patient, patient.identifier, patient+effective-time, patient+status, patient+status+effective-time, status | \n\nMedicationAdministration:medication \n | \n\nProvenance:target \n | \n\n |
\nMedicationDispense\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationdispense\n | \ny | \ny | \n\n | \n | patient, patient.identifier, patient+status, patient+whenhandedover, status, whenhandedover | \n\nMedicationDispense:medication \n | \n\nProvenance:target \n | \n\n |
\nMedicationRequest\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationrequest\n | \ny | \ny | \n\n | \n | _id, authoredon, category, identifier, intent, patient, patient.identifier, patient+intent, patient+intent+authoredon, patient+intent+status, status | \n\nMedicationRequest:medication \n | \n\nProvenance:target \n | \n\n |
\nMedicationStatement\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationstatement\n | \ny | \ny | \n\n | \n | effective, patient, patient.identifier, patient+effective, patient+status, status | \n\nMedicationStatement:medication \n | \n\nProvenance:target \n | \n\n |
\nObservation\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-observation\n \nAdditional supported profiles:\n \nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-bmi,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-waistcircum,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-bodyweight,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-bodytemp,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-diagnosticresult,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-diagnosticresult-imag,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-heartrate,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-headcircum,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-gravidity,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-healthprogramparticipation,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-oxygensat,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-pregnancystatus,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-sexassignedatbirth,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-alcoholstatus,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-norelevantfinding,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-lastmenstrualperiod,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-parity,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-smokingceasedate,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-resprate,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-diagnosticresult-path,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-lipid-result,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-smokingstatus,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-gestationalage,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-bloodpressure,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-smokingstartdate,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-estimateddateofdelivery,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-vitalspanel,\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-bodyheight\n | \ny | \ny | \n\n | \n | category, code, date, patient, patient.identifier, patient+category, patient+category+date, patient+category+status, patient+code, patient+code+date, status | \n\n | \nProvenance:target \n | \n\n |
\nOrganization\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-organization\n | \ny | \ny | \n\n | \n | _id, address, identifier, name | \n\n | \nProvenance:target \n | \n\n |
\nPatient\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-patient\n | \ny | \ny | \n\n | \n | _id, birthdate, birthdate+family, birthdate+name, family, family+gender, gender, gender+name, identifier, indigenous-status, name, patient-gender-identity | \n\n | \nProvenance:target \n | \n\n |
\nPractitioner\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner\n | \ny | \ny | \n\n | \n | _id, identifier, name | \n\n | \nProvenance:target \n | \n\n |
\nPractitionerRole\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole\n | \ny | \ny | \n\n | \n | _id, identifier, organization, practitioner, practitioner.identifier, specialty | \n\nPractitionerRole:practitioner \n | \n\nProvenance:target \n | \n\n |
\nProcedure\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-procedure\n | \ny | \ny | \n\n | \n | code, date, patient, patient.identifier, patient+code+date, patient+date, patient+status, status | \n\n | \nProvenance:target \n | \n\n |
\nProvenance\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-provenance\n | \ny | \ny | \n\n | \n | \n | \n | \n | \n |
\nRelatedPerson\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson\n | \ny | \ny | \n\n | \n | _id, name, identifier, patient, patient.identifier, patient+relationship | \n\n | \nProvenance:target \n | \n\n |
\nServiceRequest\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-servicerequest\n | \ny | \ny | \n\n | \n | _id, authored, category, code, identifier, patient, patient.identifier, patient+category, patient+category+authored, patient+category+status, patient+code, patient+code+authored, patient+status, status | \n\n | \nProvenance:target \n | \n\n |
\nSpecimen\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-specimen\n | \ny | \ny | \n\n | \n | _id, patient, patient.identifier | \n\n | \nProvenance:target \n | \n\n |
\nSubstance\n | \n\nhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-substance\n | \ny | \n\n | \n | \n | \n | \n | \n | \n |
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the AllergyIntolerance resource, the client SHALL support the AU Core profile and the conformance expectations for the AllergyIntolerance resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n MAY\n | \n\n clinical-status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHOULD\n | \n\n patient+ clinical-status\n | \n\n reference + token \n | \n
resolves
\nread
.\nsearch-type
.\n\n\n\n\nObservation, Procedure and ServiceRequest resources can represent body site information, using an external reference to a BodyStructure resource. If the client supports the BodyStructure resource, the client SHALL support the AU Core profile and the conformance expectations for the BodyStructure resource.
\n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the CarePlan resource, the client SHALL support the AU Core profile and the conformance expectations for the CarePlan resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n MAY\n | \n\n category\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n date\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHALL\n | \n\n patient+ category\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ category+ status\n | \n\n reference + token + token \n | \n
\n SHOULD\n | \n\n patient+ category+ status+ date\n | \n\n reference + token + token + date \n | \n
\n SHOULD\n | \n\n patient+ category+ date\n | \n\n reference + date \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the CareTeam resource, the client SHALL support the AU Core profile and the conformance expectations for the CareTeam resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the Composition resource, the client SHALL support the AU Core profile and the conformance expectations for the Composition resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n _id\n | \n\n token \n | \n\n |
\n SHOULD\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n SHOULD\n | \n\n identifier\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n category\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n type\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n date\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHALL\n | \n\n patient+ category\n | \n\n reference + token \n | \n
\n SHALL\n | \n\n patient+ category+ date\n | \n\n reference + token + date \n | \n
\n SHOULD\n | \n\n patient+ category+ status\n | \n\n reference + token + token \n | \n
\n SHOULD\n | \n\n patient+ status\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ type\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ type+ date\n | \n\n reference + token + date \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the Condition resource, the client SHALL support the AU Core profile and the conformance expectations for the Condition resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n MAY\n | \n\n category\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n clinical-status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n code\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n onset-date\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHALL\n | \n\n patient+ clinical-status\n | \n\n reference + token \n | \n
\n SHALL\n | \n\n patient+ category\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ category+ clinical-status\n | \n\n reference + token + token \n | \n
\n SHOULD\n | \n\n patient+ code\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ onset-date\n | \n\n reference + date \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the Coverage resource, the client SHALL support the AU Core profile and the conformance expectations for the Coverage resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n SHOULD\n | \n\n identifier\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n type\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the Device resource, the client SHALL support the AU Core profile and the conformance expectations for the Device resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHOULD\n | \n\n _id\n | \n\n token \n | \n\n |
\n SHOULD\n | \n\n identifier\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n type\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the DiagnosticReport resource, the client SHALL support the AU Core profile and the conformance expectations for the DiagnosticReport resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHOULD\n | \n\n _id\n | \n\n token \n | \n\n |
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n SHOULD\n | \n\n identifier\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n category\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n code\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n date\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHALL\n | \n\n patient+ category\n | \n\n reference + token \n | \n
\n SHALL\n | \n\n patient+ category+ date\n | \n\n reference + token + date \n | \n
\n SHOULD\n | \n\n patient+ category+ status\n | \n\n reference + token + token \n | \n
\n SHOULD\n | \n\n patient+ code\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ code+ date\n | \n\n reference + token + date \n | \n
\n SHOULD\n | \n\n patient+ status\n | \n\n reference + token \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the DocumentReference resource, the client SHALL support the AU Core profile and the conformance expectations for the DocumentReference resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n _id\n | \n\n token \n | \n\n |
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n SHOULD\n | \n\n identifier\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n category\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n contenttype\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n date\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n type\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHALL\n | \n\n patient+ category\n | \n\n reference + token \n | \n
\n SHALL\n | \n\n patient+ category+ date\n | \n\n reference + token + date \n | \n
\n SHOULD\n | \n\n patient+ category+ status\n | \n\n reference + token + token \n | \n
\n SHOULD\n | \n\n patient+ type\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ type+ date\n | \n\n reference + token + date \n | \n
\n SHOULD\n | \n\n patient+ contenttype\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ status\n | \n\n reference + token \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the Encounter resource, the client SHALL support the AU Core profile and the conformance expectations for the Encounter resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n \n \n \n The client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n \n \n \n The client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n MAY\n | \n\n class\n | \n\n token \n | \n \n \n \n The client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n date\n | \n\n date \n | \n \n \n \n The client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
\n MAY\n | \n\n discharge-disposition\n | \n\n token \n | \n \n \n \n The client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n identifier\n | \n\n token \n | \n \n \n \n The client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n location\n | \n\n reference \n | \n \n \n \n The client SHALL provide at least an id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n \n \n \n The client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n type\n | \n\n token \n | \n \n \n \n The client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHALL\n | \n\n patient+ date\n | \n\n reference + date \n | \n
\n SHOULD\n | \n\n patient+ class\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ discharge-disposition\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ location\n | \n\n reference + reference \n | \n
\n SHOULD\n | \n\n patient+ status\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ type\n | \n\n reference + token \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the HealthcareService resource, the client SHALL support the AU Core profile and the conformance expectations for the HealthcareService resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n name\n | \n\n string \n | \n\n |
\n SHOULD\n | \n\n identifier\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using HPI-O identifier as defined in the profile. \nThe server SHOULD support search using HPI-O identifier as defined in the profile. \n | \n
\n SHOULD\n | \n\n location\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least an id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n organization\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least an id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n service-category\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n service-type\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n specialty\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the Immunization resource, the client SHALL support the AU Core profile and the conformance expectations for the Immunization resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n MAY\n | \n\n date\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n vaccine-code\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
resolves
\n read
,search-type
.\n \n\n\n\nIf the client supports the List resource, the client SHALL support the AU Core profile and the conformance expectations for the List resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHOULD\n | \n\n _id\n | \n\n token \n | \n \n |
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n \n \n \n The client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n \n \n \n The client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n SHOULD\n | \n\n identifier\n | \n\n token \n | \n \n \n \n The client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n code\n | \n\n token \n | \n \n \n \n The client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n date\n | \n\n date \n | \n \n \n \n The client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
\n SHALL\n | \n\n encounter\n | \n\n reference \n | \n \n \n \n The client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n \n \n \n The client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHOULD\n | \n\n patient+ code\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ code+ date\n | \n\n reference + token + date \n | \n
\n SHOULD\n | \n\n patient+ status\n | \n\n reference + token \n | \n
resolves
\n read
,search-type
.\n \n\n\n\nIf the client supports the Location resource, the client SHALL support the AU Core profile and the conformance expectations for the Location resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n address\n | \n\n string \n | \n \n |
\n SHALL\n | \n\n name\n | \n\n string \n | \n \n |
\n SHOULD\n | \n\n address-city\n | \n\n string \n | \n \n |
\n SHOULD\n | \n\n address-state\n | \n\n string \n | \n \n |
\n SHOULD\n | \n\n address-postalcode\n | \n\n string \n | \n \n |
\n MAY\n | \n\n identifier\n | \n\n token \n | \n \n \n \n The client SHALL provide at least a code value and SHOULD provide both the system and code values. \nThe server SHALL support both. \n | \n
resolves
\nread
.\nsearch-type
.\n\n\n\n\nMedicationAdministration, MedicationDispense, MedicationRequest, and MedicationStatement resources can represent a medication, using an external reference to a Medication resource. If the client supports the Medication resource, the client SHALL support the AU Core profile and the conformance expectations for the Medication resource.
\n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the MedicationAdministration resource, the client SHALL support the AU Core profile and the conformance expectations for the MedicationAdministration resource.
\nThe MedicationAdministration 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 server MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the
\n_include
parameter for searching this element. The client application SHALL support all methods.
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n MAY\n | \n\n effective-time\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHOULD\n | \n\n patient+ effective-time\n | \n\n reference + date \n | \n
\n SHALL\n | \n\n patient+ status\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ status+ effective-time\n | \n\n reference + token + date \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the MedicationDispense resource, the client SHALL support the AU Core profile and the conformance expectations for the MedicationDispense resource.
\nThe MedicationDispense 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 server MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the
\n_include
parameter for searching this element. The client application SHALL support all methods.
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n whenhandedover\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHALL\n | \n\n patient+ status\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ whenhandedover\n | \n\n reference + date \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the MedicationRequest resource, the client SHALL support the AU Core profile and the conformance expectations for the MedicationRequest resource.
\nThe 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 server MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the
\n_include
parameter for searching this element. The client application SHALL support all methods.
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHOULD\n | \n\n _id\n | \n\n token \n | \n\n |
\n SHOULD\n | \n\n identifier\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n MAY\n | \n\n authoredon\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
\n MAY\n | \n\n category\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n intent\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the MedicationStatement resource, the client SHALL support the AU Core profile and the conformance expectations for the MedicationStatement resource.
\nThe 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 server MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the
\n_include
parameter for searching this element. The client application SHALL support all methods.
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n MAY\n | \n\n effective\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the Observation resource, the client SHALL support the AU Core profile and the conformance expectations for the Observation resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n MAY\n | \n\n category\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n code\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n date\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHALL\n | \n\n patient+ category\n | \n\n reference + token \n | \n
\n SHALL\n | \n\n patient+ category+ date\n | \n\n reference + token + date \n | \n
\n SHALL\n | \n\n patient+ category+ status\n | \n\n reference + token + token \n | \n
\n SHALL\n | \n\n patient+ code\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ code+ date\n | \n\n reference + token + date \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the Organization resource, the client SHALL support the AU Core profile and the conformance expectations for the Organization resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n address\n | \n\n string \n | \n\n |
\n SHALL\n | \n\n identifier\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and SHOULD provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using HPI-O and ABN identifiers as defined in the profile. \nThe server SHOULD support search using HPI-O and ABN identifiers as defined in the profile. \n | \n
\n SHALL\n | \n\n name\n | \n\n string \n | \n\n |
\n SHOULD\n | \n\n _id\n | \n\n token \n | \n\n |
resolves
\nread
,search-type
.\n\n\n\n\nThe client SHALL support the Patient resource, the AU Core profile, and the conformance expectations for the Patient resource.
\nClients SHALL be able to access the patient record using the following API call:
\n\n
\nGET [url]/Patient/[id]
\nClients SHOULD use these search parameters that servers are required to support to access the patient record:
\n\n
\n- \n
\n_id
\n- \n
\nidentifier
\nServers are not required to support any additional search parameters, and clients SHOULD NOT expect servers to do so.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n _id\n | \n\n token \n | \n\n |
\n SHALL\n | \n\n identifier\n | \n\n token \n | \n\n \n \n\n \n The client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n SHOULD\n | \n\n name\n | \n\n string \n | \n\n |
\n SHOULD\n | \n\n family\n | \n\n string \n | \n\n |
\n MAY\n | \n\n birthdate\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the day offset. \nThe server SHALL support a value precise to the day offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
\n MAY\n | \n\n gender\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n indigenous-status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n patient-gender-identity\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHOULD\n | \n\n birthdate+ family\n | \n\n date + string \n | \n
\n SHOULD\n | \n\n birthdate+ name\n | \n\n date + string \n | \n
\n SHOULD\n | \n\n family+ gender\n | \n\n string + token \n | \n
\n SHOULD\n | \n\n gender+ name\n | \n\n reference + string \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the Practitioner resource, the client SHALL support the AU Core profile and the conformance expectations for the Practitioner resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHOULD\n | \n\n identifier\n | \n\n token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using a HPI-I identifier as defined in the profile. \nThe server SHOULD support search using a HPI-I identifier as defined in the profile. \n | \n
\n SHOULD\n | \n\n name\n | \n\n string \n | \n\n |
\n SHOULD\n | \n\n _id\n | \n\n token \n | \n\n |
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the PractitionerRole resource, the client SHALL support the AU Core profile and the conformance expectations for the PractitionerRole resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n identifier\n | \n\n token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using a HPI-I identifier as defined in the profile. \nThe server SHOULD support search using a HPI-I identifier as defined in the profile. \n | \n
\n SHALL\n | \n\n practitioner\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least an id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n practitioner.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide at least a code value and SHOULD provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using a HPI-I identifier as defined in the AU Core Practitioner profile. \nThe server SHOULD support search using a HPI-I identifier as defined in the AU Core Practitioner profile. \n | \n
\n SHOULD\n | \n\n _id\n | \n\n token \n | \n\n |
\n SHOULD\n | \n\n specialty\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n organization\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least an id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the Procedure resource, the client SHALL support the AU Core profile and the conformance expectations for the Procedure resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n MAY\n | \n\n code\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n date\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
resolves
\nread
.\nsearch-type
.\n\n\n\n\nIf the client supports the Provenance resource, the client SHALL support the AU Core profile and the conformance expectations for the Provenance resource.
\n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the RelatedPerson resource, the client SHALL support the AU Core profile and the conformance expectations for the RelatedPerson resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n SHOULD\n | \n\n _id\n | \n\n token \n | \n\n |
\n SHOULD\n | \n\n identifier\n | \n\n token \n | \n\n \n \n\n \n The client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core RelatedPerson profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core RelatedPerson profile. \n | \n
\n SHOULD\n | \n\n name\n | \n\n string \n | \n\n |
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHOULD\n | \n\n patient+ relationship\n | \n\n reference + string \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the ServiceRequest resource, the client SHALL support the AU Core profile and the conformance expectations for the ServiceRequest resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHOULD\n | \n\n _id\n | \n\n token \n | \n\n |
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
\n SHOULD\n | \n\n identifier\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n category\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n code\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
\n MAY\n | \n\n authored\n | \n\n date \n | \n\n \n \nThe client SHALL provide a value precise to the second + time offset. \nThe server SHALL support a value precise to the second + time offset. \nThe client SHALL support these search comparators The server SHALL support these search comparators | \n
\n MAY\n | \n\n status\n | \n\n token \n | \n\n \n \nThe client SHALL provide at least a code value and MAY provide both the system and code values. \nThe server SHALL support both. \n | \n
Conformance | \nParameters | \nTypes | \n
---|---|---|
\n SHALL\n | \n\n patient+ category\n | \n\n reference + token \n | \n
\n SHALL\n | \n\n patient+ category+ status\n | \n\n reference + token + token \n | \n
\n SHALL\n | \n\n patient+ category+ authored\n | \n\n reference + token + date \n | \n
\n SHALL\n | \n\n patient+ code\n | \n\n reference + token \n | \n
\n SHOULD\n | \n\n patient+ code+ authored\n | \n\n reference + token + date \n | \n
\n SHOULD\n | \n\n patient+ status\n | \n\n reference + token \n | \n
resolves
\nread
,search-type
.\n\n\n\n\nIf the client supports the Specimen resource, the client SHALL support the AU Core profile and the conformance expectations for the Specimen resource.
\n
Conformance | \nParameter | \nType | \nDocumentation | \n
---|---|---|---|
\n SHALL\n | \n\n patient\n | \n\n reference \n | \n\n \n \nThe client SHALL provide at least a id value and MAY provide both the Type and id values. \nThe server SHALL support both. \n | \n
\n SHOULD\n | \n\n _id\n | \n\n token \n | \n\n |
\n SHOULD\n | \n\n patient.identifier\n | \n\n reference.token \n | \n\n \n \nThe client SHALL provide both the system and code values. \nThe server SHALL support both. \nThe client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \nThe server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. \n | \n
resolves
\nread
.\nsearch-type
.\n\n\n\n\nIf the client supports the Substance resource, the client SHALL support the AU Core profile and the conformance expectations for the Substance resource.
\n