Australian Base Implementation Guide (AU Base 2)

This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-cspregistrationnumber

AU Contracted Service Provider Registration Number [FMM Level 0]

This identifier profile defines a Contracted Service Provider (CSP) registration number[1] in an Australian context. A CSP registration number may be issued to organisations who wish to participate in the My Health Record as a CSP.

Examples

ACME Pathology with NATA Number, ARBN, ABN, ACN, HPI-O, PAI-O and CSP

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-cspregistrationnumber

This identifier profile defines a Contracted Service Provider (CSP) registration number in an Australian context.

This profile builds on Identifier.

This profile was published on Tue Jul 21 00:00:00 AEST 2020 as a draft by Health Level Seven Australia (Patient Administration WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierContracted Service Provider (CSP) Registration Number
inv-csp-0: CSP registration number shall be 16 digits
inv-csp-1: CSP registration number prefix shall be 800363
... type 0..1CodeableConceptIdentifier type for CSP registration number
.... text 0..1stringPlain text representation of the concept
Fixed Value: CSP
... system 1..1uriNamespace for CSP registration number
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0
... value 1..1stringCSP registration number
Example CSP registration number: 8003635500000327
Max Length: 16

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierContracted Service Provider (CSP) Registration Number
inv-csp-0: CSP registration number shall be 16 digits
inv-csp-1: CSP registration number prefix shall be 800363
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI0..1CodeableConceptIdentifier type for CSP registration number
Binding: Identifier Type Codes (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
Fixed Value: CSP
... system ΣI1..1uriNamespace for CSP registration number
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0
... value ΣI1..1stringCSP registration number
Example General: 123456
Example CSP registration number: 8003635500000327
Max Length: 16
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierContracted Service Provider (CSP) Registration Number
inv-csp-0: CSP registration number shall be 16 digits
inv-csp-1: CSP registration number prefix shall be 800363
... type 0..1CodeableConceptIdentifier type for CSP registration number
.... text 0..1stringPlain text representation of the concept
Fixed Value: CSP
... system 1..1uriNamespace for CSP registration number
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0
... value 1..1stringCSP registration number
Example CSP registration number: 8003635500000327
Max Length: 16

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierContracted Service Provider (CSP) Registration Number
inv-csp-0: CSP registration number shall be 16 digits
inv-csp-1: CSP registration number prefix shall be 800363
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI0..1CodeableConceptIdentifier type for CSP registration number
Binding: Identifier Type Codes (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
Fixed Value: CSP
... system ΣI1..1uriNamespace for CSP registration number
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0
... value ΣI1..1stringCSP registration number
Example General: 123456
Example CSP registration number: 8003635500000327
Max Length: 16
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-cspregistrationnumber

not specified