Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: CSC Number

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/csc-number Version: 0.4.1
Active as of 2025-08-31 Computable Name: CscNumber

Community Services Card holder number

Context of Use

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

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 CSC Number
... extension 0..0
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/csc-number"
... value[x] 0..1 Identifier Value of extension
.... system 0..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/csc-id

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension CSC Number
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/csc-number"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..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.
.... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/csc-id
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type Identifier: Community Services Card holder number

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension CSC Number
... extension 0..0
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/csc-number"
... value[x] 0..1 Identifier Value of extension
.... system 0..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/csc-id

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension CSC Number
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/csc-number"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..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.
.... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/csc-id
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type Identifier: Community Services Card holder number

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Extension.value[x].typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard

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