AU Base Implementation Guide
4.2.2-ballot - Ballot Australia flag

This page is part of the Australian Base IG (v4.2.2-ballot: AU Base R4.2 Ballot 5) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, see the Directory of published versions

Extension: IHI Status

Official URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status Version: 4.2.2-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: IHIStatus

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This extension applies to the Identifier data type and is used to represent the status of the associated Individual Healthcare Identifier (IHI) and indicates whether the status of the IHI is active or otherwise.

This extension may be used on the following element(s):

  • Element ID Identifier

Usage Notes

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension IHI status
... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/ihi-status"
... value[x] 1..1 Coding IHI number status
Binding: Individual Healthcare Identifier Status . (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension IHI status
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/ihi-status"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension of type Coding: This extension applies to the Identifier data type and is used to represent the status of the associated Individual Healthcare Identifier (IHI) and indicates whether the status of the IHI is active or otherwise.

Maturity: 3

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension IHI status
... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/ihi-status"
... value[x] 1..1 Coding IHI number status
Binding: Individual Healthcare Identifier Status . (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension IHI status
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/ihi-status"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.value[x]requiredIndividualHealthcareIdentifierStatus . (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/ihi-status-1)
https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()