Australian Base Implementation Guide (AU Base 1)

This page is part of the Australian Base IG (v1.0.2: AU Base 1 on STU3) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-patient

AU Base Patient Profile [FMM Level 3]

This profile defines a patient administration details structure that includes core localisation concepts for use in an Australian context.

Identifiers

These definitions represent common data held in the Patient.identifier element:

  • Individual Healthcare Identifier - IHI [1] [2]
  • Medicare Number [1] [2]
  • DVA (Department of Veterans’ Affairs) Number [1] [2]
  • Health Care Card Number, Pensioner Concession Card Number, Commonwealth Seniors Health Card Number [1] [2]
  • Medical Record Number - ABN scoped[1], HPI-O scoped[2]
  • Private Health Insurance Member Number

Extensions

Extensions used in this profile:

  • Patient: Indigenous Status [1] [2]
  • Patient: Closing the Gap registration [1] [2]
  • Patient: Birth Place (Core Extension) [1]
  • Patient: Mother’s Maiden Name (Core Extension) [1]
  • Patient.birthDate: Birth Time (Core Extension) [1]
  • Patient.birthDate, Patient.deceasedDateTime: Date Accuracy Indicator [1]
  • Patient.identifier(IHI): IHI Status [1]
  • Patient.identifier(IHI): IHI Record Status [1]

Usage Notes

Mutiple Individual Healthcare Identifiers are supported particularly to support the recording of IHI values where the status and/or record status varies (e.g. deceased, provisional).

Medicare Number is defined as a 10 or 11 digit number. Whilst 10 digits is not sufficient to uniquely identify an individual it is a supported entry where systems do not support 11 digit content. If required profiles can constrain this slice further to restrict usage to 11 digits only as desired. Medicare Numbers are not used for uniquely identifying patients, they are identifying information that can be used in conjunction with other elements such as name and date of birth appropriately to confirm identity.

Examples

Patient with IHI, Medicare Number, and Health Care Card

Patient with IHI and DVA Number

Patient with no birth date, and eligible for Closing the Gap registration

Patient with BirthTime

Patient born in 2008

Patient Sarah Simmons linked to related person Sarah Simmons

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-patient

This profile defines a patient administration details structure that includes core localisation concepts for use in an Australian context.

This profile builds on Patient.

This profile was published on Wed Mar 06 10:07:00 AEDT 2019 as a active by Health Level Seven Australia (Patient Administration WG).

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

This profile contains the following variations from Patient:

  1. extension sliced
    • Patient Birth Place extension
    • Patient Indigenous Status extension
    • Patient Closing the Gap Registration extension
    • Patient Mother’s Maiden Name extension
  2. identifier sliced
    • identifier National Individual Healthcare Identifier (IHI)
      • Individual Healthcare Identifier (IHI) Number Status extension
      • Individual Healthcare Identifier (IHI) Number Record Status extension
    • identifier Medicare Number
    • identifier Department of Veterans’ Affairs (DVA) Number
    • identifier Health Care Card Number
    • identifier Pensioner Concession Card Number
    • identifier Commonwealth Seniors Health Card Number
    • identifier Medical Record Number (MRN)
    • identifier Private Health Insurance Member Number
  3. birthDate Date of birth extended for time and accuracy indicator
    • Birth Date Accuracy Indicator extension
    • Birth Time extension
  4. deceased[x] sliced
    • deceased[x] Deceased Indicator
    • deceased[x] Deceased Date Time
      • Deceased Date Accuracy Indicator extension
  5. communication
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*A patient in an Australian healthcare context
inv-pat-0: If there is a birth time its date shall be the birth date
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... birthPlace 0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... indigenous-status 0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
... closing-the-gap-registration 0..1booleanPatient Closing the Gap Registration
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName 0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... identifier IdentifierSlice: Unordered, Open by pattern:type, value:system
... identifier I0..*IdentifierNational Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... ihi-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
.... ihi-record-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
.... type 0..1CodeableConceptCoded identifier type for IHI
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"NI"}]}
..... text 0..1stringFixed Value: IHI
.... system 1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
.... value 1..1stringIHI number
Example IHI number': 8003608833357361
Max Length: 16
... identifier 0..*IdentifierMedicare Number
.... type 0..1CodeableConceptCoded identifier type for Medicare number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MC"}]}
..... text 0..1stringFixed Value: Medicare Number
.... system 1..1uriNamespace for Medicare number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
.... value 1..1stringMedicare number including optional individual reference number
Example Medicare number': 32788511952
Max Length: 11
.... period 1..1PeriodMedicare number validity period
..... end 1..1dateTimeMedicare number expiry date
... identifier I0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
inv-dva-number-unspecified: DVA number identifier type text must be 'DVA Number' when colour is not specified
inv-dva-number-gold: DVA number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG.
inv-dva-number-white: DVA number identifier type text must be 'DVA Number (White)' when colour coding is DVW.
inv-dva-number-orange: DVA number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO.
inv-dva-number-lilac: DVA number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL.
inv-dva-number-text: DVA number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)'
.... type 0..1CodeableConceptCoded identifier type for DVA number
Binding: v2 Identifier Type - AU Extended (required)
..... text 0..1string
.... system 1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
.... value 1..1stringDVA number
Example Department of Veterans' Affairs (DVA) number': NBUR9080
Max Length: 9
... identifier 0..*IdentifierHealth Care Card Number
.... type 1..1CodeableConceptCoded identifier type for Health Care Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC"}]}
..... text 0..1stringFixed Value: Health Care Card Number
.... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value 1..1stringCentrelink CRN
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..*IdentifierPensioner Concession Card Number
.... type 1..1CodeableConceptCoded identifier type for Pensioner Concession Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN"}]}
..... text 0..1stringFixed Value: Pensioner Concession Card Number
.... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value 1..1stringCentrelink CRN
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..*IdentifierCommonwealth Seniors Health Card Number
.... type 1..1CodeableConceptCoded identifier type for Commonwealth Seniors Health Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN"}]}
..... text 0..1stringFixed Value: Commonwealth Seniors Health Card
.... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value 1..1stringCentrelink CRN
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..*IdentifierMedical Record Number (MRN)
.... type 1..1CodeableConceptCoded identifier type for MRN
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MR"}]}
..... text 0..1stringFixed Value: Medical Record Number
.... system 1..1uriMedical record number system namespace
.... value 1..1stringMedical record number
.... assigner 1..1Reference(Organization)Medical record number assigning entity
... identifier 0..*IdentifierPrivate Health Insurance Member Number
.... type 1..1CodeableConceptCoded identifier type for private health insurance member number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MB"}]}
..... text 0..1stringFixed Value: Private Health Insurance Member Number
.... value 1..1stringPrivate health insurance member number
.... assigner 1..1Reference(Organization)Private health insurer
..... display 1..1string
... birthDate 0..1dateDate of birth extended for time and accuracy indicator
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... date-accuracy-indicator 0..1CodingBirth 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)
.... patient-birthTime 0..1dateTimeBirth Time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... deceased[x] boolean, dateTimeSlice: Unordered, Open by type:$this
​... deceased[x] 0..1booleanDeceased Indicator
​... deceased[x] 0..1dateTimeDeceased Date Time
​.... extension 0..*ExtensionSlice: Unordered, Open by value:url
​.... date-accuracy-indicator 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)
... communication 0..*BackboneElement
.... language 1..1CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*A patient in an Australian healthcare context
inv-pat-0: If there is a birth time its date shall be the birth date
... 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: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthPlace I0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... indigenous-status I0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
... closing-the-gap-registration I0..1booleanPatient Closing the Gap Registration
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName I0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:type, value:system
... identifier ΣI0..*IdentifierNational Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ihi-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/ihi-status"
..... valueCoding 1..1CodingIHI Number Status Code
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
.... ihi-record-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/ihi-record-status"
..... valueCoding 1..1CodingIHI Record Status Code
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptCoded identifier type for IHI
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"NI"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: IHI
.... system Σ1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
.... value Σ1..1stringIHI number
Example General': 123456
Example IHI number': 8003608833357361
Max Length: 16
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..*IdentifierMedicare Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptCoded identifier type for Medicare number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MC"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: Medicare Number
.... system Σ1..1uriNamespace for Medicare number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
.... value Σ1..1stringMedicare number including optional individual reference number
Example General': 123456
Example Medicare number': 32788511952
Max Length: 11
.... period Σ1..1PeriodMedicare number validity period
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣI0..1dateTimeStarting time with inclusive boundary
..... end ΣI1..1dateTimeMedicare number expiry date
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier ΣI0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
inv-dva-number-unspecified: DVA number identifier type text must be 'DVA Number' when colour is not specified
inv-dva-number-gold: DVA number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG.
inv-dva-number-white: DVA number identifier type text must be 'DVA Number (White)' when colour coding is DVW.
inv-dva-number-orange: DVA number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO.
inv-dva-number-lilac: DVA number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL.
inv-dva-number-text: DVA number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)'
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptCoded identifier type for DVA number
Binding: v2 Identifier Type - AU Extended (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... system Σ1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
.... value Σ1..1stringDVA number
Example General': 123456
Example Department of Veterans' Affairs (DVA) number': NBUR9080
Max Length: 9
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..*IdentifierHealth Care Card Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCoded identifier type for Health Care Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: Health Care Card Number
.... system Σ1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value Σ1..1stringCentrelink CRN
Example General': 123456
Example DHS CRN': 307111942H
Max Length: 10
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..*IdentifierPensioner Concession Card Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCoded identifier type for Pensioner Concession Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: Pensioner Concession Card Number
.... system Σ1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value Σ1..1stringCentrelink CRN
Example General': 123456
Example DHS CRN': 307111942H
Max Length: 10
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..*IdentifierCommonwealth Seniors Health Card Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCoded identifier type for Commonwealth Seniors Health Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: Commonwealth Seniors Health Card
.... system Σ1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value Σ1..1stringCentrelink CRN
Example General': 123456
Example DHS CRN': 307111942H
Max Length: 10
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..*IdentifierMedical Record Number (MRN)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCoded identifier type for MRN
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MR"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: Medical Record Number
.... system Σ1..1uriMedical record number system namespace
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringMedical record number
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Medical record number assigning entity
... identifier Σ0..*IdentifierPrivate Health Insurance Member Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCoded identifier type for private health insurance member number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MB"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: Private Health Insurance Member Number
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringPrivate health insurance member number
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Private health insurer
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ1..1stringText alternative for the resource
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ0..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateDate of birth extended for time and accuracy indicator
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... date-accuracy-indicator I0..1CodingBirth 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)
.... patient-birthTime I0..1dateTimeBirth Time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1Primitive value for date
... deceased[x] ?!Σ0..1boolean, dateTimeIndicates if the individual is deceased or not
... deceasedBoolean ?!Σ0..1booleanDeceased Indicator
... deceasedDateTime ?!Σ0..1dateTimeDeceased Date Time
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... date-accuracy-indicator I0..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)
.... value 0..1Primitive value for dateTime
... address Σ0..*AddressAddresses for the individual
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: v2 Contact Role (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..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
... animal ?!ΣI0..1BackboneElementThis patient is known to be an animal (non-human)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... species Σ1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example)
.... breed Σ0..1CodeableConceptE.g. Poodle, Angus
Binding: AnimalBreeds (example)
.... genderStatus Σ0..1CodeableConceptE.g. Neutered, Intact
Binding: GenderStatus (example)
... communication I0..*BackboneElementA list of Languages which may be used to communicate with the patient about his or her health
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... language 1..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 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

This profile contains the following variations from Patient:

  1. extension sliced
    • Patient Birth Place extension
    • Patient Indigenous Status extension
    • Patient Closing the Gap Registration extension
    • Patient Mother’s Maiden Name extension
  2. identifier sliced
    • identifier National Individual Healthcare Identifier (IHI)
      • Individual Healthcare Identifier (IHI) Number Status extension
      • Individual Healthcare Identifier (IHI) Number Record Status extension
    • identifier Medicare Number
    • identifier Department of Veterans’ Affairs (DVA) Number
    • identifier Health Care Card Number
    • identifier Pensioner Concession Card Number
    • identifier Commonwealth Seniors Health Card Number
    • identifier Medical Record Number (MRN)
    • identifier Private Health Insurance Member Number
  3. birthDate Date of birth extended for time and accuracy indicator
    • Birth Date Accuracy Indicator extension
    • Birth Time extension
  4. deceased[x] sliced
    • deceased[x] Deceased Indicator
    • deceased[x] Deceased Date Time
      • Deceased Date Accuracy Indicator extension
  5. communication

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*A patient in an Australian healthcare context
inv-pat-0: If there is a birth time its date shall be the birth date
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... birthPlace 0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... indigenous-status 0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
... closing-the-gap-registration 0..1booleanPatient Closing the Gap Registration
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName 0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... identifier IdentifierSlice: Unordered, Open by pattern:type, value:system
... identifier I0..*IdentifierNational Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... ihi-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
.... ihi-record-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
.... type 0..1CodeableConceptCoded identifier type for IHI
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"NI"}]}
..... text 0..1stringFixed Value: IHI
.... system 1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
.... value 1..1stringIHI number
Example IHI number': 8003608833357361
Max Length: 16
... identifier 0..*IdentifierMedicare Number
.... type 0..1CodeableConceptCoded identifier type for Medicare number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MC"}]}
..... text 0..1stringFixed Value: Medicare Number
.... system 1..1uriNamespace for Medicare number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
.... value 1..1stringMedicare number including optional individual reference number
Example Medicare number': 32788511952
Max Length: 11
.... period 1..1PeriodMedicare number validity period
..... end 1..1dateTimeMedicare number expiry date
... identifier I0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
inv-dva-number-unspecified: DVA number identifier type text must be 'DVA Number' when colour is not specified
inv-dva-number-gold: DVA number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG.
inv-dva-number-white: DVA number identifier type text must be 'DVA Number (White)' when colour coding is DVW.
inv-dva-number-orange: DVA number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO.
inv-dva-number-lilac: DVA number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL.
inv-dva-number-text: DVA number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)'
.... type 0..1CodeableConceptCoded identifier type for DVA number
Binding: v2 Identifier Type - AU Extended (required)
..... text 0..1string
.... system 1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
.... value 1..1stringDVA number
Example Department of Veterans' Affairs (DVA) number': NBUR9080
Max Length: 9
... identifier 0..*IdentifierHealth Care Card Number
.... type 1..1CodeableConceptCoded identifier type for Health Care Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC"}]}
..... text 0..1stringFixed Value: Health Care Card Number
.... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value 1..1stringCentrelink CRN
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..*IdentifierPensioner Concession Card Number
.... type 1..1CodeableConceptCoded identifier type for Pensioner Concession Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN"}]}
..... text 0..1stringFixed Value: Pensioner Concession Card Number
.... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value 1..1stringCentrelink CRN
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..*IdentifierCommonwealth Seniors Health Card Number
.... type 1..1CodeableConceptCoded identifier type for Commonwealth Seniors Health Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN"}]}
..... text 0..1stringFixed Value: Commonwealth Seniors Health Card
.... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value 1..1stringCentrelink CRN
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..*IdentifierMedical Record Number (MRN)
.... type 1..1CodeableConceptCoded identifier type for MRN
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MR"}]}
..... text 0..1stringFixed Value: Medical Record Number
.... system 1..1uriMedical record number system namespace
.... value 1..1stringMedical record number
.... assigner 1..1Reference(Organization)Medical record number assigning entity
... identifier 0..*IdentifierPrivate Health Insurance Member Number
.... type 1..1CodeableConceptCoded identifier type for private health insurance member number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MB"}]}
..... text 0..1stringFixed Value: Private Health Insurance Member Number
.... value 1..1stringPrivate health insurance member number
.... assigner 1..1Reference(Organization)Private health insurer
..... display 1..1string
... birthDate 0..1dateDate of birth extended for time and accuracy indicator
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... date-accuracy-indicator 0..1CodingBirth 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)
.... patient-birthTime 0..1dateTimeBirth Time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... deceased[x] boolean, dateTimeSlice: Unordered, Open by type:$this
​... deceased[x] 0..1booleanDeceased Indicator
​... deceased[x] 0..1dateTimeDeceased Date Time
​.... extension 0..*ExtensionSlice: Unordered, Open by value:url
​.... date-accuracy-indicator 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)
... communication 0..*BackboneElement
.... language 1..1CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*A patient in an Australian healthcare context
inv-pat-0: If there is a birth time its date shall be the birth date
... 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: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthPlace I0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... indigenous-status I0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
... closing-the-gap-registration I0..1booleanPatient Closing the Gap Registration
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName I0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:type, value:system
... identifier ΣI0..*IdentifierNational Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ihi-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/ihi-status"
..... valueCoding 1..1CodingIHI Number Status Code
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
.... ihi-record-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/ihi-record-status"
..... valueCoding 1..1CodingIHI Record Status Code
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptCoded identifier type for IHI
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"NI"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: IHI
.... system Σ1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
.... value Σ1..1stringIHI number
Example General': 123456
Example IHI number': 8003608833357361
Max Length: 16
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..*IdentifierMedicare Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptCoded identifier type for Medicare number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MC"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: Medicare Number
.... system Σ1..1uriNamespace for Medicare number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
.... value Σ1..1stringMedicare number including optional individual reference number
Example General': 123456
Example Medicare number': 32788511952
Max Length: 11
.... period Σ1..1PeriodMedicare number validity period
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣI0..1dateTimeStarting time with inclusive boundary
..... end ΣI1..1dateTimeMedicare number expiry date
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier ΣI0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
inv-dva-number-unspecified: DVA number identifier type text must be 'DVA Number' when colour is not specified
inv-dva-number-gold: DVA number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG.
inv-dva-number-white: DVA number identifier type text must be 'DVA Number (White)' when colour coding is DVW.
inv-dva-number-orange: DVA number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO.
inv-dva-number-lilac: DVA number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL.
inv-dva-number-text: DVA number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)'
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptCoded identifier type for DVA number
Binding: v2 Identifier Type - AU Extended (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... system Σ1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
.... value Σ1..1stringDVA number
Example General': 123456
Example Department of Veterans' Affairs (DVA) number': NBUR9080
Max Length: 9
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..*IdentifierHealth Care Card Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCoded identifier type for Health Care Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: Health Care Card Number
.... system Σ1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value Σ1..1stringCentrelink CRN
Example General': 123456
Example DHS CRN': 307111942H
Max Length: 10
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..*IdentifierPensioner Concession Card Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCoded identifier type for Pensioner Concession Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: Pensioner Concession Card Number
.... system Σ1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value Σ1..1stringCentrelink CRN
Example General': 123456
Example DHS CRN': 307111942H
Max Length: 10
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..*IdentifierCommonwealth Seniors Health Card Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCoded identifier type for Commonwealth Seniors Health Card number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: Commonwealth Seniors Health Card
.... system Σ1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
.... value Σ1..1stringCentrelink CRN
Example General': 123456
Example DHS CRN': 307111942H
Max Length: 10
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..*IdentifierMedical Record Number (MRN)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCoded identifier type for MRN
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MR"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: Medical Record Number
.... system Σ1..1uriMedical record number system namespace
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringMedical record number
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Medical record number assigning entity
... identifier Σ0..*IdentifierPrivate Health Insurance Member Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCoded identifier type for private health insurance member number
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MB"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
Fixed Value: Private Health Insurance Member Number
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringPrivate health insurance member number
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Private health insurer
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ1..1stringText alternative for the resource
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ0..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateDate of birth extended for time and accuracy indicator
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... date-accuracy-indicator I0..1CodingBirth 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)
.... patient-birthTime I0..1dateTimeBirth Time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1Primitive value for date
... deceased[x] ?!Σ0..1boolean, dateTimeIndicates if the individual is deceased or not
... deceasedBoolean ?!Σ0..1booleanDeceased Indicator
... deceasedDateTime ?!Σ0..1dateTimeDeceased Date Time
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... date-accuracy-indicator I0..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)
.... value 0..1Primitive value for dateTime
... address Σ0..*AddressAddresses for the individual
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: v2 Contact Role (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..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
... animal ?!ΣI0..1BackboneElementThis patient is known to be an animal (non-human)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... species Σ1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example)
.... breed Σ0..1CodeableConceptE.g. Poodle, Angus
Binding: AnimalBreeds (example)
.... genderStatus Σ0..1CodeableConceptE.g. Neutered, Intact
Binding: GenderStatus (example)
... communication I0..*BackboneElementA list of Languages which may be used to communicate with the patient about his or her health
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... language 1..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 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

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

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-patient

none defined