HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft

HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions

Extension: RegistrationStatusCode

Official URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code Version: 1.0.0
Active as of 2025-06-10 Computable Name: RegistrationStatusCode

An indicator of the practicing status of the practitioner as supplied by their Responsible Authority or professional body.

Context of Use

Example of extension

    <extension
               url="http://hl7.org.nz/fhir/StructureDefinition/registration-status-code">
      <extension url="status">
        <valueCodeableConcept>
          <coding>
            <system
                    value="https://standards.digital.health.nz/ns/practitioner-registration-status-code"/>
            <code value="current"/>
            <display
                     value="A provider who holds or is deemed to hold a current practising certificate."/>
          </coding>
        </valueCodeableConcept>
      </extension>
      <extension url="period">
        <valuePeriod>
          <start value="2021-01-01"/>
          <end value="2021-12-31"/>
        </valuePeriod>
      </extension>
    </extension>

Note that this is applied to the qualification element, not the resource root. See the full example below.

Example instances

Practitioner with Scope of Practice

Usage info

Usages:

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 & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:status 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "status"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: Registration Status of Practitioners (preferred)
.... extension:period 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "period"
..... value[x] 0..1 Period Value of extension
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/registration-status-code"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Extension
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:status 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "status"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: Registration Status of Practitioners (preferred)
.... extension:period 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "period"
..... value[x] 0..1 Period Value of extension
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/registration-status-code"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: An indicator of the practicing status of the practitioner as supplied by their Responsible Authority or professional body.

  • status: CodeableConcept: The status of this registration
  • period: Period: The period over which this status is valid

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:status 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "status"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: Registration Status of Practitioners (preferred)
.... extension:period 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "period"
..... value[x] 0..1 Period Value of extension
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/registration-status-code"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Extension
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:status 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "status"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: Registration Status of Practitioners (preferred)
.... extension:period 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "period"
..... value[x] 0..1 Period Value of extension
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/registration-status-code"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: An indicator of the practicing status of the practitioner as supplied by their Responsible Authority or professional body.

  • status: CodeableConcept: The status of this registration
  • period: Period: The period over which this status is valid

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:status.value[x]preferredPractitionerRegistrationStatusCode(a valid code from Registration Status of Practitioners)
https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-registration-status-code
From this IG

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()