Australian Digital Health Agency FHIR Implementation Guide 1.0.0

Australian Digital Health Agency FHIR Implementation Guide. This is the current published version. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available versions.

StructureDefinition: ADHA Core Patient [Active]

The purpose of this profile is to provide a core representation of a patient for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia. This profile supports Cultural and Linguistic Diversity (CALD) data set [1] [2], including country of birth, year of arrival and preferred language.

This profile identifies the additional constraints, extensions, and value sets that build on and extend Patient that are supported.

This profile is designed to set a core Patient standard for:

  • Querying for records associated with a patient
  • Record or update a record associated with a patient

Profile specific guidance

  • Country of birth is represented using Patient.extension birthPlace extension
    • A system may use address.text if birth place address is not stored in discrete elements
  • See the Representing communication preferences section for guidance
  • A patient’s biological sex is represented as a separate Observation resource

Boundaries and relationships

This profile is referenced by ADHA Core BodyStructure, ADHA Organ or Tissue for Donation BodyStructure, ADHA Core Condition, ADHA Record of Consent from Australian Organ Donor Register, ADHA Core DocumentReference, ADHA Core Encounter, ADHA Record of Claim against MBS or DVA, ADHA Record of Claim against PBS or RPBS, ADHA Australian Immunisation Register Notice, ADHA Core Flag, ADHA Record of Immunisation from Australian Immunisation Register, ADHA Core Immunization, ADHA Core MedicationRequest, ADHA PBS Claim Item, ADHA Core Observation, ADHA Core Procedure, ADHA Authoring RelatedPerson, and ADHA Core RelatedPerson.

Formal Views of Profile Content

The official URL for this profile is: 

http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1

The purpose of this profile is to provide a core representation of a patient for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile builds on AUBasePatient.

This profile was published on 2023-04-14 04:02:01+0000 as a active by Australian Digital Health Agency.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*AUBasePatientA patient in the context of electronic exchange of health information
inv-dh-pat-01: At least one patient identifier shall be valid
inv-dh-pat-02: At least one patient name shall have a family name
inv-dh-pat-03: If present, a general practitioner shall at least have a reference, an identifier or a display
... extension:birthPlace S0..1birthPlacePlace of Birth for patient
... extension:indigenousStatus S0..1AustralianIndigenousStatusIndigenous status
... extension:interpreterRequired S0..1interpreterRequiredWhether the patient needs an interpreter
... extension:dateOfArrival S0..1DateOfArrivalAustraliaYear of Arrival
... Slices for identifier SC1..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberIdentifies this patient across multiple systems
Slice: Unordered, Open by pattern:type
.... identifier:ihi S0..1AUIHIIndividual Healthcare Identifier (IHI)
.... identifier:medicare S0..1AUMedicareCardNumberMedicare Card Number
.... identifier:dva S0..1AUDVANumberDepartment of Veterans' Affairs (DVA) Number
... active 0..1booleanWhether this patient's record is in active use
Fixed Value: true
... name SC1..*HumanNameA name associated with the patient
inv-dh-pat-04: At least text, family name, or given name shall be present
... telecom S0..*ContactPointA contact detail for the individual
... gender S1..1codemale | female | other | unknown
... birthDate S1..1dateDate of birth extended for time and accuracy indicator
.... extension:accuracyIndicator S0..1DateAccuracyIndicatorDate accuracy indicator
.... extension:birthTime S0..1birthTimeTime of day of birth
... address S0..*AustralianAddress, AddressAn address for the individual
... communication S0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
.... preferred S0..1booleanLanguage preference indicator
... generalPractitioner SC0..*Reference(ADHA Core Organization | ADHA Core PractitionerRole)Patient's nominated primary care provider

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*AUBasePatientA patient in the context of electronic exchange of health information
inv-dh-pat-01: At least one patient identifier shall be valid
inv-dh-pat-02: At least one patient name shall have a family name
inv-dh-pat-03: If present, a general practitioner shall at least have a reference, an identifier or a display
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenousStatus S0..1CodingIndigenous status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
... closingTheGapRegistration 0..1booleanClosing the Gap co-payment eligibility indicator
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... mothersMaidenName 0..1stringMother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... interpreterRequired S0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... dateOfArrival S0..1dateYear of Arrival
URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SC1..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberIdentifies this patient across multiple systems
Slice: Unordered, Open by pattern:type
.... identifier:ihi SC0..1AUIHIIndividual Healthcare Identifier (IHI)
.... identifier:medicare S0..1AUMedicareCardNumberMedicare Card Number
.... identifier:dva S0..1AUDVANumberDepartment of Veterans' Affairs (DVA) Number
... active ?!Σ0..1booleanWhether this patient's record is in active use
Fixed Value: true
... name SΣC1..*HumanNameA name associated with the patient
inv-dh-pat-04: At least text, family name, or given name shall be present
... telecom SΣ0..*ContactPointA contact detail for the individual
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ1..1dateDate of birth extended for time and accuracy indicator
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... accuracyIndicator S0..1CodingDate accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding


.... birthTime S0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1datePrimitive value for date
... Slices for deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
.... deceased[x]:deceasedBoolean ?!Σ0..1booleanDeceased indicator
.... deceased[x]:deceasedDateTime ?!Σ0..1dateTimeDeceased date time
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... accuracyIndicator 0..1CodingDeceased date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding


..... value 0..1dateTimePrimitive value for dateTime
... address SC0..*AustralianAddress, AddressAn address for the individual
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1Address, AustralianAddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication S0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
.... preferred S0..1booleanLanguage preference indicator
... generalPractitioner SC0..*Reference(ADHA Core Organization | ADHA Core PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to a Patient or RelatedPerson resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*AUBasePatientA patient in the context of electronic exchange of health information
inv-dh-pat-01: At least one patient identifier shall be valid
inv-dh-pat-02: At least one patient name shall have a family name
inv-dh-pat-03: If present, a general practitioner shall at least have a reference, an identifier or a display
... extension:birthPlace S0..1birthPlacePlace of Birth for patient
... extension:indigenousStatus S0..1AustralianIndigenousStatusIndigenous status
... extension:interpreterRequired S0..1interpreterRequiredWhether the patient needs an interpreter
... extension:dateOfArrival S0..1DateOfArrivalAustraliaYear of Arrival
... Slices for identifier SC1..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberIdentifies this patient across multiple systems
Slice: Unordered, Open by pattern:type
.... identifier:ihi S0..1AUIHIIndividual Healthcare Identifier (IHI)
.... identifier:medicare S0..1AUMedicareCardNumberMedicare Card Number
.... identifier:dva S0..1AUDVANumberDepartment of Veterans' Affairs (DVA) Number
... active 0..1booleanWhether this patient's record is in active use
Fixed Value: true
... name SC1..*HumanNameA name associated with the patient
inv-dh-pat-04: At least text, family name, or given name shall be present
... telecom S0..*ContactPointA contact detail for the individual
... gender S1..1codemale | female | other | unknown
... birthDate S1..1dateDate of birth extended for time and accuracy indicator
.... extension:accuracyIndicator S0..1DateAccuracyIndicatorDate accuracy indicator
.... extension:birthTime S0..1birthTimeTime of day of birth
... address S0..*AustralianAddress, AddressAn address for the individual
... communication S0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
.... preferred S0..1booleanLanguage preference indicator
... generalPractitioner SC0..*Reference(ADHA Core Organization | ADHA Core PractitionerRole)Patient's nominated primary care provider

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*AUBasePatientA patient in the context of electronic exchange of health information
inv-dh-pat-01: At least one patient identifier shall be valid
inv-dh-pat-02: At least one patient name shall have a family name
inv-dh-pat-03: If present, a general practitioner shall at least have a reference, an identifier or a display
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenousStatus S0..1CodingIndigenous status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
... closingTheGapRegistration 0..1booleanClosing the Gap co-payment eligibility indicator
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... mothersMaidenName 0..1stringMother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... interpreterRequired S0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... dateOfArrival S0..1dateYear of Arrival
URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SC1..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberIdentifies this patient across multiple systems
Slice: Unordered, Open by pattern:type
.... identifier:ihi SC0..1AUIHIIndividual Healthcare Identifier (IHI)
.... identifier:medicare S0..1AUMedicareCardNumberMedicare Card Number
.... identifier:dva S0..1AUDVANumberDepartment of Veterans' Affairs (DVA) Number
... active ?!Σ0..1booleanWhether this patient's record is in active use
Fixed Value: true
... name SΣC1..*HumanNameA name associated with the patient
inv-dh-pat-04: At least text, family name, or given name shall be present
... telecom SΣ0..*ContactPointA contact detail for the individual
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ1..1dateDate of birth extended for time and accuracy indicator
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... accuracyIndicator S0..1CodingDate accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding


.... birthTime S0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1datePrimitive value for date
... Slices for deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
.... deceased[x]:deceasedBoolean ?!Σ0..1booleanDeceased indicator
.... deceased[x]:deceasedDateTime ?!Σ0..1dateTimeDeceased date time
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... accuracyIndicator 0..1CodingDeceased date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding


..... value 0..1dateTimePrimitive value for dateTime
... address SC0..*AustralianAddress, AddressAn address for the individual
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1Address, AustralianAddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication S0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
.... preferred S0..1booleanLanguage preference indicator
... generalPractitioner SC0..*Reference(ADHA Core Organization | ADHA Core PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to a Patient or RelatedPerson resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusextensibleMarital Status Codes
Patient.contact.relationshipextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languageextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2
Patient.link.typerequiredLinkType

Search Parameters

None defined.