AU Core Implementation Guide
0.2.1-preview - Preview
This page is part of the Australian Core IG (v0.2.1-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient | Version: 0.2.1-preview | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: AUCorePatient | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
This profile sets minimum expectations for a Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It is based on the AU Base Patient profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Patient when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
A resource conforming to this profile is conformant to:
Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.
Patient.identifier
if available, in preference to Medicare or DVA numbersSpecific feedback is sought on preferred identifiers to support where an individual is not eligible for an IHI e.g. tourist or other temporary stay in Australia. Passport is proposed for use (see example Patient/italia-sofia).
Specific feedback is sought on whether MRN is to be a supported identifier for patients.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.
Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
---|---|---|---|
_id | SHALL | token |
|
identifier | SHALL | token |
The client SHALL provide both the system and code values. The server SHALL support both. The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the profile. |
birthdate+family | SHOULD | date +string |
|
birthdate+name | SHOULD | date +string |
|
family | SHOULD | string |
|
family+gender | SHOULD | string +token |
|
gender+name | SHOULD | token +string |
|
name | SHOULD | string |
|
birthdate | MAY | date |
A client SHALL provide a value precise to the day. A server SHALL support a value precise to the day offset. |
gender | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
indigenous-status | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
patient-gender-identity | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
_id
search parameter:
_revinclude
parameters: Provenance:target
GET [base]/Patient/[id]
or GET [base]/Patient?_id=[id]
Example:
Implementation Notes: Returns a single Patient resource. (how to search by the logical id of the resource)
identifier
search parameter:
_revinclude
parameters: Provenance:target
GET [base]/Patient?identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle containing any Patient resources matching the identifier (how to search by token)
Implementation Notes: Fetches a bundle of all Patient resources matching the name (how to search by string)
The following search parameters and search parameter combinations SHOULD be supported:
name
search parameter:
_revinclude
parameters: Provenance:target
GET [base]/Patient?name=[string]
Example:
gender
and name
search parameters:
_revinclude
parameters: Provenance:target
GET [base]/Patient?gender={system|}[code]&name=[string]
Example:
Implementation Notes: Fetches a bundle of all Patient resources matching the specified gender and name (how to search by string and how to search by token)
birthdate
and family
search parameters:
_revinclude
parameters: Provenance:target
GET [base]/Patient?birthdate=[date]&family=[string]
Example:
Implementation Notes: Fetches a bundle of all Patient resources matching the specified birthdate and family (how to search by date and how to search by string)
birthdate
and name
search parameters:
_revinclude
parameters: Provenance:target
GET [base]/Patient?birthdate=[date]&name=[string]
Example:
Implementation Notes: Fetches a bundle of all Patient resources matching the specified birthdate and name (how to search by date and how to search by string)
family
and gender
search parameters:
_revinclude
parameters: Provenance:target
GET [base]/Patient?family=[string]&gender={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all Patient resources matching the specified family and gender (how to search by string and how to search by token)
gender
and name
search parameters:
_revinclude
parameters: Provenance:target
GET [base]/Patient?gender={system|}[code]&name=[string]
Example:
Implementation Notes: Fetches a bundle of all Patient resources matching the specified gender and name (how to search by token and how to search by string)