Australian Base Profiles Implementation Guide

1.0 StructureDefinition-au-patient

Australian Human Patient Profile

This profile defines a patient administration details structure that includes core localisation concepts.

This definition is for human patients only, for non-human patients it is recommended the base Patient resource definition be used.

Identifiers

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

The numerical identifier that uniquely identifies each individual in the Australian healthcare system.

The IHI identifier may also include extension properties IHI Status and IHI Record Status associated with the IHI value.

Person identifier, allocated by the Health Insurance Commission to eligible persons under the Medicare scheme, that appears on a Medicare card.

The Medicare card number should only be collected from persons eligible to receive health services that are to be funded by the Commonwealth government. The number should be reported to the appropriate government agency to reconcile payment for the service provided. The data should not be used by private sector organisations for any other purpose unless specifically authorised by law. For example, data linkage should not be carried out unless specifically authorised by law.

Medicare number may also include an expiry date associated with the number.

The data should not be used by private sector organisations for any purpose unless specifically authorised by law. For example, private sector organisations should not use the DVA file number for data linking unless specifically authorised by relevant privacy legislation.

DVA number may also include details of the specific card colour associated with the number.

  • Health Care Card Number
  • Pensioner Concession Card Number
  • Commonwealth Seniors Health Card Number

(METeOR CRN Description)

All of the above mentioned cards use Centerlink Customer Reference Number.

A personal identifier assigned by Centrelink for the purposes of identifying people (and organisations) eligible for specific services, including some public health care services, such as oral health services.

The CRN should only be collected from persons eligible to receive health services that are to be funded by Centrelink. The number may be reported to a Centrelink agency to reconcile payment for the service provided. The data should not be used by private sector organisations for any purpose unless specifically authorised by law. For example, data linkage should not be carried out unless specifically authorised by law.

Extensions

Definitions here describe extensions to the Patient resource.

This extension is added to hold the administrative indigenous status of an individual. The Commonwealth defintion of indigenous status is “An Aboriginal or Torres Strait Islander is a person of Aboriginal or Torres Strait Islander descent who identifies as an Aboriginal or Torres Strait Islander and is accepted as such by the community in which he or she lives”

Indigenous status is defined as a coded concept associated with the patient.

Examples

Patient with IHI, Medicare Number, and Health Care Card

Patient with IHI and DVA Number

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

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

Australian realm Patient profile

This profile builds on Patient.

This profile was published on Sat Mar 11 17:30:54 AEDT 2017 as a draft by Health Level Seven Australia (Patient Administration).

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

Australian Patient Profile contains:

  1. Base: Patient (as Patient)
  2. Optional IHI (as Identifier)
    • Optional IHI status
    • Optional IHI record status
  3. Optional Medicare Number (as Identifier)
  4. Optional DVA Number (as Identifier)
    • Optional DVA card colour identifier type
  5. Optional Concession Card Number (as Identifier)
    • Choice (Identifier.type) - Health Care Card, Pensioner Concession Card, Commonwealth Seniors Health Card
  6. Optional Indigenous Status (as Extension)
  7. Exclusion: Patient.animal (BackboneElement) - human only
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*
... identifier IdentifierSlice: Unordered, Open At End by value:system, value:type
... identifier I0..1IdentifierNational Individual Health Identifier
inv-ihi-0: IHI is exactly 16 characters
inv-ihi-1: IHI prefix is 800360
.... type 1..1CodeableConcept
..... coding 0..1CodingFixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"NI","display":"National unique individual identifier"}
..... text 1..1stringFixed Value: IHI
.... system 1..1urinational namespace for ihi
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
.... value 1..1stringIndividual Health Identifier number
Example IHI number': 8003608166690503
Max Length: 16
.... extension-au-ihi-status 0..1CodingIHI Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-status
Binding: Individual Healthcare Identifier Status (IHI Status) (required)
.... extension-au-ihi-record-status 0..1CodingIHI Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-record-status
Binding: Individual Healthcare Identifier Record Status (IHI Record Status) (required)
... identifier 0..1IdentifierMedicare Number
.... type 1..1CodeableConcept
..... coding 0..1CodingFixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"MC","display":"Patient's Medicare Number"}
..... text 1..1stringFixed Value: Medicare Number
.... system 1..1urinational namespace for medicare
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
.... value 1..1stringMedicare Number value including optional individual reference number
Example Medicare number': 32788511952
Max Length: 11
.... period 1..1Period
..... end 1..1dateTime
... identifier I0..1IdentifierDVA 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-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange)'
.... type 1..1CodeableConcept
..... coding 0..1CodingBinding: v2 Identifier Type - AU Extended - DVA Specifc Card Types (required)
..... text 1..1string
.... system 1..1uriDVA number identifier system
Fixed Value: http://ns.electronichealth.net.au/id/dva
.... value 1..1stringDVA number value
Example DVA number': NBUR9080
Max Length: 9
... identifier 0..1IdentifierHealth Care Card Identifier
.... type 1..1CodeableConceptHealth Care Card Identifier Type
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC","display":"Health Card Number"}],"text":"Health Care Card Number"}
.... system 1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/crn
.... value 1..1stringCentrelink Customer Reference Number (CRN)
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..1IdentifierPensioner Concession Card Identifier
.... type 1..1CodeableConceptPensioner Concession Card Identifier Type
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN","display":"Pension Number"}],"text":"Pensioner Concession Card Number"}
.... system 1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/crn
.... value 1..1stringCentrelink Customer Reference Number (CRN)
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..1IdentifierCommonwealth Seniors Health Card Identifier
.... type 1..1CodeableConceptCommonwealth Seniors Health Card Identifier Type
Fixed Value: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN","display":"Commonwealth Seniors Health Card"}],"text":"Commonwealth Seniors Health Card"}
.... system 1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/crn
.... value 1..1stringCentrelink Customer Reference Number (CRN)
Example DHS CRN': 307111942H
Max Length: 10
... animal 0..0
... indigenous-status 0..1CodingAustralian Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: Australian Indigenous Status (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*Information about an individual or animal receiving health care services
... 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... indigenous-status 0..1CodingAustralian Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: Australian Indigenous Status (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierAn identifier for this patient
Slice: Unordered, Open At End by value:system, value:type
... identifier ΣI0..1IdentifierNational Individual Health Identifier
inv-ihi-0: IHI is exactly 16 characters
inv-ihi-1: IHI prefix is 800360
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension-au-ihi-status 0..1CodingIHI Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-status
Binding: Individual Healthcare Identifier Status (IHI Status) (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaValue of extension
.... extension-au-ihi-record-status 0..1CodingIHI Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-record-status
Binding: Individual Healthcare Identifier Record Status (IHI Record Status) (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaValue of extension
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingCode defined by a terminology system

Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"NI","display":"National unique individual identifier"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: IHI
.... system Σ1..1urinational namespace for ihi
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
.... value Σ1..1stringIndividual Health Identifier number
Example General': 123456
Example IHI number': 8003608166690503
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..1IdentifierMedicare Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingCode defined by a terminology system

Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"MC","display":"Patient's Medicare Number"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Medicare Number
.... system Σ1..1urinational namespace for medicare
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
.... value Σ1..1stringMedicare Number value including optional individual reference number
Example General': 123456
Example Medicare number': 32788511952
Max Length: 11
.... period Σ1..1PeriodTime period when id is/was valid for use
..... id 0..1stringxml:id (or equivalent in JSON)
..... start ΣI0..1dateTimeStarting time with inclusive boundary
..... end ΣI1..1dateTimeEnd time with inclusive boundary, if not ongoing
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier ΣI0..1IdentifierDVA 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-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange)'
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingCode defined by a terminology system
Binding: v2 Identifier Type - AU Extended - DVA Specifc Card Types (required)
..... text Σ1..1stringPlain text representation of the concept
.... system Σ1..1uriDVA number identifier system
Fixed Value: http://ns.electronichealth.net.au/id/dva
.... value Σ1..1stringDVA number value
Example General': 123456
Example 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..1IdentifierHealth Care Card Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptHealth Care Card Identifier Type
Binding: Identifier Type Codes (extensible)
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC","display":"Health Card Number"}],"text":"Health Care Card Number"}
.... system Σ1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/crn
.... value Σ1..1stringCentrelink Customer Reference Number (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..1IdentifierPensioner Concession Card Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptPensioner Concession Card Identifier Type
Binding: Identifier Type Codes (extensible)
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN","display":"Pension Number"}],"text":"Pensioner Concession Card Number"}
.... system Σ1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/crn
.... value Σ1..1stringCentrelink Customer Reference Number (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..1IdentifierCommonwealth Seniors Health Card Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCommonwealth Seniors Health Card Identifier Type
Binding: Identifier Type Codes (extensible)
Fixed Value: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN","display":"Commonwealth Seniors Health Card"}],"text":"Commonwealth Seniors Health Card"}
.... system Σ1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/crn
.... value Σ1..1stringCentrelink Customer Reference Number (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)
... 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..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1boolean, dateTimeIndicates if the individual is deceased or not
... 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
... 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: Common Languages (extensible)
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization), Reference(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), Reference(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

Australian Patient Profile contains:

  1. Base: Patient (as Patient)
  2. Optional IHI (as Identifier)
    • Optional IHI status
    • Optional IHI record status
  3. Optional Medicare Number (as Identifier)
  4. Optional DVA Number (as Identifier)
    • Optional DVA card colour identifier type
  5. Optional Concession Card Number (as Identifier)
    • Choice (Identifier.type) - Health Care Card, Pensioner Concession Card, Commonwealth Seniors Health Card
  6. Optional Indigenous Status (as Extension)
  7. Exclusion: Patient.animal (BackboneElement) - human only

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*
... identifier IdentifierSlice: Unordered, Open At End by value:system, value:type
... identifier I0..1IdentifierNational Individual Health Identifier
inv-ihi-0: IHI is exactly 16 characters
inv-ihi-1: IHI prefix is 800360
.... type 1..1CodeableConcept
..... coding 0..1CodingFixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"NI","display":"National unique individual identifier"}
..... text 1..1stringFixed Value: IHI
.... system 1..1urinational namespace for ihi
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
.... value 1..1stringIndividual Health Identifier number
Example IHI number': 8003608166690503
Max Length: 16
.... extension-au-ihi-status 0..1CodingIHI Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-status
Binding: Individual Healthcare Identifier Status (IHI Status) (required)
.... extension-au-ihi-record-status 0..1CodingIHI Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-record-status
Binding: Individual Healthcare Identifier Record Status (IHI Record Status) (required)
... identifier 0..1IdentifierMedicare Number
.... type 1..1CodeableConcept
..... coding 0..1CodingFixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"MC","display":"Patient's Medicare Number"}
..... text 1..1stringFixed Value: Medicare Number
.... system 1..1urinational namespace for medicare
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
.... value 1..1stringMedicare Number value including optional individual reference number
Example Medicare number': 32788511952
Max Length: 11
.... period 1..1Period
..... end 1..1dateTime
... identifier I0..1IdentifierDVA 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-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange)'
.... type 1..1CodeableConcept
..... coding 0..1CodingBinding: v2 Identifier Type - AU Extended - DVA Specifc Card Types (required)
..... text 1..1string
.... system 1..1uriDVA number identifier system
Fixed Value: http://ns.electronichealth.net.au/id/dva
.... value 1..1stringDVA number value
Example DVA number': NBUR9080
Max Length: 9
... identifier 0..1IdentifierHealth Care Card Identifier
.... type 1..1CodeableConceptHealth Care Card Identifier Type
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC","display":"Health Card Number"}],"text":"Health Care Card Number"}
.... system 1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/crn
.... value 1..1stringCentrelink Customer Reference Number (CRN)
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..1IdentifierPensioner Concession Card Identifier
.... type 1..1CodeableConceptPensioner Concession Card Identifier Type
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN","display":"Pension Number"}],"text":"Pensioner Concession Card Number"}
.... system 1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/crn
.... value 1..1stringCentrelink Customer Reference Number (CRN)
Example DHS CRN': 307111942H
Max Length: 10
... identifier 0..1IdentifierCommonwealth Seniors Health Card Identifier
.... type 1..1CodeableConceptCommonwealth Seniors Health Card Identifier Type
Fixed Value: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN","display":"Commonwealth Seniors Health Card"}],"text":"Commonwealth Seniors Health Card"}
.... system 1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/crn
.... value 1..1stringCentrelink Customer Reference Number (CRN)
Example DHS CRN': 307111942H
Max Length: 10
... animal 0..0
... indigenous-status 0..1CodingAustralian Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: Australian Indigenous Status (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*Information about an individual or animal receiving health care services
... 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... indigenous-status 0..1CodingAustralian Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: Australian Indigenous Status (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierAn identifier for this patient
Slice: Unordered, Open At End by value:system, value:type
... identifier ΣI0..1IdentifierNational Individual Health Identifier
inv-ihi-0: IHI is exactly 16 characters
inv-ihi-1: IHI prefix is 800360
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension-au-ihi-status 0..1CodingIHI Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-status
Binding: Individual Healthcare Identifier Status (IHI Status) (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaValue of extension
.... extension-au-ihi-record-status 0..1CodingIHI Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/extension-au-ihi-record-status
Binding: Individual Healthcare Identifier Record Status (IHI Record Status) (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaValue of extension
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingCode defined by a terminology system

Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"NI","display":"National unique individual identifier"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: IHI
.... system Σ1..1urinational namespace for ihi
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
.... value Σ1..1stringIndividual Health Identifier number
Example General': 123456
Example IHI number': 8003608166690503
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..1IdentifierMedicare Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingCode defined by a terminology system

Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"MC","display":"Patient's Medicare Number"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Medicare Number
.... system Σ1..1urinational namespace for medicare
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
.... value Σ1..1stringMedicare Number value including optional individual reference number
Example General': 123456
Example Medicare number': 32788511952
Max Length: 11
.... period Σ1..1PeriodTime period when id is/was valid for use
..... id 0..1stringxml:id (or equivalent in JSON)
..... start ΣI0..1dateTimeStarting time with inclusive boundary
..... end ΣI1..1dateTimeEnd time with inclusive boundary, if not ongoing
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier ΣI0..1IdentifierDVA 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-text: DVA Number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange)'
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingCode defined by a terminology system
Binding: v2 Identifier Type - AU Extended - DVA Specifc Card Types (required)
..... text Σ1..1stringPlain text representation of the concept
.... system Σ1..1uriDVA number identifier system
Fixed Value: http://ns.electronichealth.net.au/id/dva
.... value Σ1..1stringDVA number value
Example General': 123456
Example 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..1IdentifierHealth Care Card Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptHealth Care Card Identifier Type
Binding: Identifier Type Codes (extensible)
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC","display":"Health Card Number"}],"text":"Health Care Card Number"}
.... system Σ1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/crn
.... value Σ1..1stringCentrelink Customer Reference Number (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..1IdentifierPensioner Concession Card Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptPensioner Concession Card Identifier Type
Binding: Identifier Type Codes (extensible)
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN","display":"Pension Number"}],"text":"Pensioner Concession Card Number"}
.... system Σ1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/crn
.... value Σ1..1stringCentrelink Customer Reference Number (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..1IdentifierCommonwealth Seniors Health Card Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCommonwealth Seniors Health Card Identifier Type
Binding: Identifier Type Codes (extensible)
Fixed Value: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN","display":"Commonwealth Seniors Health Card"}],"text":"Commonwealth Seniors Health Card"}
.... system Σ1..1urinamespace for Centrelink CRN identifiers
Fixed Value: http://ns.electronichealth.net.au/id/crn
.... value Σ1..1stringCentrelink Customer Reference Number (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)
... 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..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1boolean, dateTimeIndicates if the individual is deceased or not
... 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
... 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: Common Languages (extensible)
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization), Reference(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), Reference(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