Te Whatu Ora, Central Region Integration Hub
1.0.12-rc1 - ci-build New Zealand flag

Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.12-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions

Extension: NZ Central Region Referral

Official URL: https://standards.digital.health.nz/ns/central-region/referral Version: 1.0.12-rc1
Active as of 2024-09-17 Computable Name: NZCentralRegionExtensionReferral

Complex extension recording extra data about referrals

Context of Use

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

  • Element ID ServiceRequest

Usage info

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

Summary

Complex Extension: Complex extension recording extra data about referrals

  • consultingPractitioner: Reference: The consulting doctor(s) or Responsible HCP for this visit or Referral.
  • preferredSite: Coding: Which site does patient prefer to attend the referral?
  • referralSource: Coding: Which organisation hospital department made the referral? Not to be confused with requestor which is the actual clinician.
  • referringPractice: Reference: When source is General Practice, which medical practice (or other DHB) made the referral?
  • healthPurchaser: Coding: Which funding source is paying for the referral?
  • clinicType: Coding: Which clinic Type, run by the Department/Location, is the referral for?
  • clinicId: string: Which individual clinic, run by the Department/Location, is the referral for? CodeSystem would be too dynamic, so recorded as a String value
  • healthSpeciality: string: What category of treatment is the patient to receive? Coding values unknown, so recorded as a String value
  • financialClass: string: Identifies the source of payment/reimbursement for treatment. Coding values unknown, so recorded as a String value
  • lastUpdated: dateTime: Date and time the referral was last updated in the originating system?
  • informGP: boolean: Is Patient's GP to be informed about referral?
  • webPASPriority: Coding: What was the original raw priority setting on the referral?
  • webPASStatus: Coding: What was the original raw status setting on the referral?
  • dateReceived: date: The date on which the referral was entered into the PAS system; this may be hours after it was received by Mental Health staff
  • effectiveDateTime: dateTime: The date & time on which the referral was received by Mental Health staff, this may be hours before it was entered into the PAS system.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NZ Central Region Referral
... id 0..0
... extension 2..* Extension Container holding the individual elements of the Referral extension.
... Slices for extension Content/Rules for all slices
.... extension:consultingPractitioner S 0..* Extension Consultant
..... extension 0..0
..... url 1..1 uri "consultingPractitioner"
..... value[x] 0..1 Reference() Value of extension
...... id 0..0
...... extension 0..0
...... identifier S 0..1 Identifier Logical reference, when literal reference is not known
....... id 0..0
....... extension 0..0
....... use S 1..1 code usual | official | temp | secondary | old (If known)
....... type S 1..1 CodeableConcept Description of identifier
........ id 0..0
........ extension 0..0
........ coding S 0..* Coding Code defined by a terminology system
......... id 0..0
......... extension 0..0
......... system S 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..0
......... code S 1..1 code Symbol in syntax defined by the system
Required Pattern: LR
......... display S 1..1 string Representation defined by the system
Required Pattern: Local Registry ID
......... userSelected 0..0
........ text 0..0
....... system S 1..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
....... period 0..0
....... assigner 0..0
...... display 0..0
.... extension:preferredSite S 0..1 Extension Which hospital / clinic does patient prefer to attend?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "preferredSite"
..... value[x] S 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Site Value Set (required)
...... id 0..0
...... extension 0..0
...... version 0..0
...... userSelected 0..0
.... extension:referralSource S 0..1 Extension Which organisation / hospital department made the referral?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "referralSource"
..... value[x] S 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Source Value Set (required)
...... id 0..0
...... extension 0..0
...... version 0..0
...... userSelected 0..0
.... extension:referringPractice S 0..1 Extension Which medical practice made the referral?
..... extension 0..0
..... url 1..1 uri "referringPractice"
..... value[x] 0..1 Reference() Value of extension
...... id 0..0
...... extension 0..0
...... reference S 0..1 string Literal reference, Relative, internal or absolute URL
...... type S 1..1 uri Medical Practice is an Organisation
Required Pattern: Organization
...... identifier S 0..1 Identifier Logical reference, when literal reference is not known
....... id 0..0
....... extension 0..0
....... use S 1..1 code usual | official | temp | secondary | old (If known)
....... type S 1..1 CodeableConcept Description of identifier
........ id 0..0
........ extension 0..0
........ coding S 0..* Coding Code defined by a terminology system
......... id 0..0
......... extension 0..0
......... system S 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..0
......... code S 1..1 code Symbol in syntax defined by the system
Required Pattern: LR
......... display S 1..1 string Representation defined by the system
Required Pattern: Local Registry ID
......... userSelected 0..0
........ text 0..0
....... system S 1..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practice-id
....... period 0..0
....... assigner 0..0
...... display 0..0
.... extension:healthPurchaser S 0..1 Extension Which funding source is paying for the referral?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "healthPurchaser"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Health Purchaser Value Set (required)
...... id 0..0
...... extension 0..0
...... version 0..0
...... userSelected 0..0
.... extension:clinicType S 0..1 Extension Which clinic Type is the referral to?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "clinicType"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Clinic Type Value Set (required)
...... id 0..0
...... extension 0..0
...... version 0..0
...... userSelected 0..0
.... extension:clinicId S 0..1 Extension Which particular clinic is the referral for?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "clinicId"
..... value[x] 0..1 string Value of extension
.... extension:healthSpeciality S 1..1 Extension What category of treatment is the patient to receive?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "healthSpeciality"
..... value[x] 0..1 string Value of extension
.... extension:financialClass S 1..1 Extension The source of payment/reimbursement for treatment.
..... id 0..0
..... extension 0..0
..... url 1..1 uri "financialClass"
..... value[x] 0..1 string Value of extension
.... extension:lastUpdated S 0..1 Extension When was the referral last updated in the originating system?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "lastUpdated"
..... value[x] 0..1 dateTime Value of extension
.... extension:informGP S 0..1 Extension Is Patient's GP to be informed about referral?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "informGP"
..... value[x] 0..1 boolean Value of extension
.... extension:webPASPriority S 0..1 Extension Raw referral priority?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "webPASPriority"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Priority Value Set (required)
...... id 0..0
...... extension 0..0
...... system S 1..1 uri Identity of the terminology system
...... version 0..0
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
...... userSelected 0..0
.... extension:webPASStatus S 0..1 Extension Raw referral status?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "webPASStatus"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Status Value Set (required)
...... id 0..0
...... extension 0..0
...... system S 1..1 uri Identity of the terminology system
...... version 0..0
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
...... userSelected 0..0
.... extension:dateReceived S 0..1 Extension The date on which the referral was entered into the PAS system.
..... id 0..0
..... extension 0..0
..... url 1..1 uri "dateReceived"
..... value[x] 0..1 date Value of extension
.... extension:effectiveDateTime S 0..1 Extension The date & time on which the referral was received by Mental Health staff
..... id 0..0
..... extension 0..0
..... url 1..1 uri "effectiveDateTime"
..... value[x] 0..1 dateTime Value of extension
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NZ Central Region Referral
... Slices for extension 2..* Extension Container holding the individual elements of the Referral extension.
Slice: Unordered, Open by value:url
.... extension:consultingPractitioner S 0..* Extension Consultant
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "consultingPractitioner"
..... value[x] 0..1 Reference() Value of extension
...... extension 0..0
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
....... extension 0..0
....... use ?!SΣ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type SΣ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

........ extension 0..0
........ coding SΣ 0..* Coding Code defined by a terminology system
......... extension 0..0
......... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
......... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: LR
......... display SΣ 1..1 string Representation defined by the system
Required Pattern: Local Registry ID
....... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
....... value Σ 0..1 string The value that is unique
Example General: 123456
.... extension:preferredSite S 0..1 Extension Which hospital / clinic does patient prefer to attend?
..... extension 0..0
..... url 1..1 uri "preferredSite"
..... value[x] S 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Site Value Set (required)
...... extension 0..0
...... system Σ 0..1 uri Identity of the terminology system
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... extension:referralSource S 0..1 Extension Which organisation / hospital department made the referral?
..... extension 0..0
..... url 1..1 uri "referralSource"
..... value[x] S 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Source Value Set (required)
...... extension 0..0
...... system Σ 0..1 uri Identity of the terminology system
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... extension:referringPractice S 0..1 Extension Which medical practice made the referral?
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "referringPractice"
..... value[x] 0..1 Reference() Value of extension
...... extension 0..0
...... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type SΣ 1..1 uri Medical Practice is an Organisation
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).


Required Pattern: Organization
...... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
....... extension 0..0
....... use ?!SΣ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type SΣ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

........ extension 0..0
........ coding SΣ 0..* Coding Code defined by a terminology system
......... extension 0..0
......... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
......... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: LR
......... display SΣ 1..1 string Representation defined by the system
Required Pattern: Local Registry ID
....... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practice-id
....... value Σ 0..1 string The value that is unique
Example General: 123456
.... extension:healthPurchaser S 0..1 Extension Which funding source is paying for the referral?
..... extension 0..0
..... url 1..1 uri "healthPurchaser"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Health Purchaser Value Set (required)
...... extension 0..0
...... system Σ 0..1 uri Identity of the terminology system
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... extension:clinicType S 0..1 Extension Which clinic Type is the referral to?
..... extension 0..0
..... url 1..1 uri "clinicType"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Clinic Type Value Set (required)
...... extension 0..0
...... system Σ 0..1 uri Identity of the terminology system
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... extension:clinicId S 0..1 Extension Which particular clinic is the referral for?
..... extension 0..0
..... url 1..1 uri "clinicId"
..... value[x] 0..1 string Value of extension
.... extension:healthSpeciality S 1..1 Extension What category of treatment is the patient to receive?
..... extension 0..0
..... url 1..1 uri "healthSpeciality"
..... value[x] 0..1 string Value of extension
.... extension:financialClass S 1..1 Extension The source of payment/reimbursement for treatment.
..... extension 0..0
..... url 1..1 uri "financialClass"
..... value[x] 0..1 string Value of extension
.... extension:lastUpdated S 0..1 Extension When was the referral last updated in the originating system?
..... extension 0..0
..... url 1..1 uri "lastUpdated"
..... value[x] 0..1 dateTime Value of extension
.... extension:informGP S 0..1 Extension Is Patient's GP to be informed about referral?
..... extension 0..0
..... url 1..1 uri "informGP"
..... value[x] 0..1 boolean Value of extension
.... extension:webPASPriority S 0..1 Extension Raw referral priority?
..... extension 0..0
..... url 1..1 uri "webPASPriority"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Priority Value Set (required)
...... extension 0..0
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
.... extension:webPASStatus S 0..1 Extension Raw referral status?
..... extension 0..0
..... url 1..1 uri "webPASStatus"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Status Value Set (required)
...... extension 0..0
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
.... extension:dateReceived S 0..1 Extension The date on which the referral was entered into the PAS system.
..... extension 0..0
..... url 1..1 uri "dateReceived"
..... value[x] 0..1 date Value of extension
.... extension:effectiveDateTime S 0..1 Extension The date & time on which the referral was received by Mental Health staff
..... extension 0..0
..... url 1..1 uri "effectiveDateTime"
..... value[x] 0..1 dateTime Value of extension
... url 1..1 uri "https://standards.digital.health.nz/ns/central-region/referral"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Complex extension recording extra data about referrals

  • consultingPractitioner: Reference: The consulting doctor(s) or Responsible HCP for this visit or Referral.
  • preferredSite: Coding: Which site does patient prefer to attend the referral?
  • referralSource: Coding: Which organisation hospital department made the referral? Not to be confused with requestor which is the actual clinician.
  • referringPractice: Reference: When source is General Practice, which medical practice (or other DHB) made the referral?
  • healthPurchaser: Coding: Which funding source is paying for the referral?
  • clinicType: Coding: Which clinic Type, run by the Department/Location, is the referral for?
  • clinicId: string: Which individual clinic, run by the Department/Location, is the referral for? CodeSystem would be too dynamic, so recorded as a String value
  • healthSpeciality: string: What category of treatment is the patient to receive? Coding values unknown, so recorded as a String value
  • financialClass: string: Identifies the source of payment/reimbursement for treatment. Coding values unknown, so recorded as a String value
  • lastUpdated: dateTime: Date and time the referral was last updated in the originating system?
  • informGP: boolean: Is Patient's GP to be informed about referral?
  • webPASPriority: Coding: What was the original raw priority setting on the referral?
  • webPASStatus: Coding: What was the original raw status setting on the referral?
  • dateReceived: date: The date on which the referral was entered into the PAS system; this may be hours after it was received by Mental Health staff
  • effectiveDateTime: dateTime: The date & time on which the referral was received by Mental Health staff, this may be hours before it was entered into the PAS system.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NZ Central Region Referral
... id 0..0
... extension 2..* Extension Container holding the individual elements of the Referral extension.
... Slices for extension Content/Rules for all slices
.... extension:consultingPractitioner S 0..* Extension Consultant
..... extension 0..0
..... url 1..1 uri "consultingPractitioner"
..... value[x] 0..1 Reference() Value of extension
...... id 0..0
...... extension 0..0
...... identifier S 0..1 Identifier Logical reference, when literal reference is not known
....... id 0..0
....... extension 0..0
....... use S 1..1 code usual | official | temp | secondary | old (If known)
....... type S 1..1 CodeableConcept Description of identifier
........ id 0..0
........ extension 0..0
........ coding S 0..* Coding Code defined by a terminology system
......... id 0..0
......... extension 0..0
......... system S 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..0
......... code S 1..1 code Symbol in syntax defined by the system
Required Pattern: LR
......... display S 1..1 string Representation defined by the system
Required Pattern: Local Registry ID
......... userSelected 0..0
........ text 0..0
....... system S 1..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
....... period 0..0
....... assigner 0..0
...... display 0..0
.... extension:preferredSite S 0..1 Extension Which hospital / clinic does patient prefer to attend?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "preferredSite"
..... value[x] S 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Site Value Set (required)
...... id 0..0
...... extension 0..0
...... version 0..0
...... userSelected 0..0
.... extension:referralSource S 0..1 Extension Which organisation / hospital department made the referral?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "referralSource"
..... value[x] S 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Source Value Set (required)
...... id 0..0
...... extension 0..0
...... version 0..0
...... userSelected 0..0
.... extension:referringPractice S 0..1 Extension Which medical practice made the referral?
..... extension 0..0
..... url 1..1 uri "referringPractice"
..... value[x] 0..1 Reference() Value of extension
...... id 0..0
...... extension 0..0
...... reference S 0..1 string Literal reference, Relative, internal or absolute URL
...... type S 1..1 uri Medical Practice is an Organisation
Required Pattern: Organization
...... identifier S 0..1 Identifier Logical reference, when literal reference is not known
....... id 0..0
....... extension 0..0
....... use S 1..1 code usual | official | temp | secondary | old (If known)
....... type S 1..1 CodeableConcept Description of identifier
........ id 0..0
........ extension 0..0
........ coding S 0..* Coding Code defined by a terminology system
......... id 0..0
......... extension 0..0
......... system S 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..0
......... code S 1..1 code Symbol in syntax defined by the system
Required Pattern: LR
......... display S 1..1 string Representation defined by the system
Required Pattern: Local Registry ID
......... userSelected 0..0
........ text 0..0
....... system S 1..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practice-id
....... period 0..0
....... assigner 0..0
...... display 0..0
.... extension:healthPurchaser S 0..1 Extension Which funding source is paying for the referral?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "healthPurchaser"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Health Purchaser Value Set (required)
...... id 0..0
...... extension 0..0
...... version 0..0
...... userSelected 0..0
.... extension:clinicType S 0..1 Extension Which clinic Type is the referral to?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "clinicType"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Clinic Type Value Set (required)
...... id 0..0
...... extension 0..0
...... version 0..0
...... userSelected 0..0
.... extension:clinicId S 0..1 Extension Which particular clinic is the referral for?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "clinicId"
..... value[x] 0..1 string Value of extension
.... extension:healthSpeciality S 1..1 Extension What category of treatment is the patient to receive?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "healthSpeciality"
..... value[x] 0..1 string Value of extension
.... extension:financialClass S 1..1 Extension The source of payment/reimbursement for treatment.
..... id 0..0
..... extension 0..0
..... url 1..1 uri "financialClass"
..... value[x] 0..1 string Value of extension
.... extension:lastUpdated S 0..1 Extension When was the referral last updated in the originating system?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "lastUpdated"
..... value[x] 0..1 dateTime Value of extension
.... extension:informGP S 0..1 Extension Is Patient's GP to be informed about referral?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "informGP"
..... value[x] 0..1 boolean Value of extension
.... extension:webPASPriority S 0..1 Extension Raw referral priority?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "webPASPriority"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Priority Value Set (required)
...... id 0..0
...... extension 0..0
...... system S 1..1 uri Identity of the terminology system
...... version 0..0
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
...... userSelected 0..0
.... extension:webPASStatus S 0..1 Extension Raw referral status?
..... id 0..0
..... extension 0..0
..... url 1..1 uri "webPASStatus"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Status Value Set (required)
...... id 0..0
...... extension 0..0
...... system S 1..1 uri Identity of the terminology system
...... version 0..0
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
...... userSelected 0..0
.... extension:dateReceived S 0..1 Extension The date on which the referral was entered into the PAS system.
..... id 0..0
..... extension 0..0
..... url 1..1 uri "dateReceived"
..... value[x] 0..1 date Value of extension
.... extension:effectiveDateTime S 0..1 Extension The date & time on which the referral was received by Mental Health staff
..... id 0..0
..... extension 0..0
..... url 1..1 uri "effectiveDateTime"
..... value[x] 0..1 dateTime Value of extension
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NZ Central Region Referral
... Slices for extension 2..* Extension Container holding the individual elements of the Referral extension.
Slice: Unordered, Open by value:url
.... extension:consultingPractitioner S 0..* Extension Consultant
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "consultingPractitioner"
..... value[x] 0..1 Reference() Value of extension
...... extension 0..0
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
....... extension 0..0
....... use ?!SΣ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type SΣ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

........ extension 0..0
........ coding SΣ 0..* Coding Code defined by a terminology system
......... extension 0..0
......... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
......... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: LR
......... display SΣ 1..1 string Representation defined by the system
Required Pattern: Local Registry ID
....... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
....... value Σ 0..1 string The value that is unique
Example General: 123456
.... extension:preferredSite S 0..1 Extension Which hospital / clinic does patient prefer to attend?
..... extension 0..0
..... url 1..1 uri "preferredSite"
..... value[x] S 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Site Value Set (required)
...... extension 0..0
...... system Σ 0..1 uri Identity of the terminology system
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... extension:referralSource S 0..1 Extension Which organisation / hospital department made the referral?
..... extension 0..0
..... url 1..1 uri "referralSource"
..... value[x] S 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Source Value Set (required)
...... extension 0..0
...... system Σ 0..1 uri Identity of the terminology system
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... extension:referringPractice S 0..1 Extension Which medical practice made the referral?
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "referringPractice"
..... value[x] 0..1 Reference() Value of extension
...... extension 0..0
...... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type SΣ 1..1 uri Medical Practice is an Organisation
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).


Required Pattern: Organization
...... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
....... extension 0..0
....... use ?!SΣ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type SΣ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

........ extension 0..0
........ coding SΣ 0..* Coding Code defined by a terminology system
......... extension 0..0
......... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
......... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: LR
......... display SΣ 1..1 string Representation defined by the system
Required Pattern: Local Registry ID
....... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practice-id
....... value Σ 0..1 string The value that is unique
Example General: 123456
.... extension:healthPurchaser S 0..1 Extension Which funding source is paying for the referral?
..... extension 0..0
..... url 1..1 uri "healthPurchaser"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Health Purchaser Value Set (required)
...... extension 0..0
...... system Σ 0..1 uri Identity of the terminology system
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... extension:clinicType S 0..1 Extension Which clinic Type is the referral to?
..... extension 0..0
..... url 1..1 uri "clinicType"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Clinic Type Value Set (required)
...... extension 0..0
...... system Σ 0..1 uri Identity of the terminology system
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... extension:clinicId S 0..1 Extension Which particular clinic is the referral for?
..... extension 0..0
..... url 1..1 uri "clinicId"
..... value[x] 0..1 string Value of extension
.... extension:healthSpeciality S 1..1 Extension What category of treatment is the patient to receive?
..... extension 0..0
..... url 1..1 uri "healthSpeciality"
..... value[x] 0..1 string Value of extension
.... extension:financialClass S 1..1 Extension The source of payment/reimbursement for treatment.
..... extension 0..0
..... url 1..1 uri "financialClass"
..... value[x] 0..1 string Value of extension
.... extension:lastUpdated S 0..1 Extension When was the referral last updated in the originating system?
..... extension 0..0
..... url 1..1 uri "lastUpdated"
..... value[x] 0..1 dateTime Value of extension
.... extension:informGP S 0..1 Extension Is Patient's GP to be informed about referral?
..... extension 0..0
..... url 1..1 uri "informGP"
..... value[x] 0..1 boolean Value of extension
.... extension:webPASPriority S 0..1 Extension Raw referral priority?
..... extension 0..0
..... url 1..1 uri "webPASPriority"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Priority Value Set (required)
...... extension 0..0
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
.... extension:webPASStatus S 0..1 Extension Raw referral status?
..... extension 0..0
..... url 1..1 uri "webPASStatus"
..... value[x] 1..1 Coding Value of extension
Binding: NZ Central Region - Referral Status Value Set (required)
...... extension 0..0
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
.... extension:dateReceived S 0..1 Extension The date on which the referral was entered into the PAS system.
..... extension 0..0
..... url 1..1 uri "dateReceived"
..... value[x] 0..1 date Value of extension
.... extension:effectiveDateTime S 0..1 Extension The date & time on which the referral was received by Mental Health staff
..... extension 0..0
..... url 1..1 uri "effectiveDateTime"
..... value[x] 0..1 dateTime Value of extension
... url 1..1 uri "https://standards.digital.health.nz/ns/central-region/referral"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / CodeURI
Extension.extension:consultingPractitioner.value[x].typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Extension.extension:consultingPractitioner.value[x].identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Extension.extension:consultingPractitioner.value[x].identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Extension.extension:preferredSite.value[x]requiredNZCentralRegionReferralSiteValueSet (a valid code from NZ Central Region - Referral Site Code System)
https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-site
from this IG
Extension.extension:referralSource.value[x]requiredNZCentralRegionReferralSourceValueSet (a valid code from NZ Central Region - Referral Source Code System)
https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-source
from this IG
Extension.extension:referringPractice.value[x].typeextensiblePattern: Organization
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Extension.extension:referringPractice.value[x].identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Extension.extension:referringPractice.value[x].identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Extension.extension:healthPurchaser.value[x]requiredNZCentralRegionHealthPurchaserValueSet (a valid code from NZ Central Region - Health Purchaser Code System)
https://standards.digital.health.nz/fhir/central-region/ValueSet-health-purchaser
from this IG
Extension.extension:clinicType.value[x]requiredNZCentralRegionClinicTypeValueSet (a valid code from NZ Central Region - Clinic Type Code System)
https://standards.digital.health.nz/fhir/central-region/ValueSet-clinic-code
from this IG
Extension.extension:webPASPriority.value[x]requiredNZCentralRegionReferralPriorityValueSet
https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-priority
from this IG
Extension.extension:webPASStatus.value[x]requiredNZCentralRegionReferralStatusValueSet (a valid code from NZ Central Region - Referral Status Code System)
https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-status
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()