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: PractitionerRoleStatusReason

Official URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Version: 1.0.0
Active as of 2025-09-08 Computable Name: PractitionerRoleStatusReason

The reason for the status. Generally only used for inactive resources.

Context of Use

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

Example of extension


  <extension url="http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason">
    <valueCodeableConcept>
      <coding>
        <system value="https://standards.digital.health.nz/ns/hpi-practitioner-role-status-reason-code"/>
        <code value="duplicate"/>
        <display value="duplicate"/>
      </coding>
    </valueCodeableConcept>
  </extension>

Example instances

PractitionerRole with inactive reason

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

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
... extension 0..0
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason"
... value[x] 0..1 CodeableConcept Value of extension
Binding: PractitionerRole status reason (preferred)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Extension
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type CodeableConcept: The reason for the status. Generally only used for inactive resources.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Extension
... extension 0..0
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason"
... value[x] 0..1 CodeableConcept Value of extension
Binding: PractitionerRole status reason (preferred)

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
... extension 0..0
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type CodeableConcept: The reason for the status. Generally only used for inactive resources.

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.value[x]preferredPractitionerRoleStatusReason(a valid code from PractitionerRole status reason)
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-practitioner-role-status-reason-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()