AU Base Implementation Guide
4.1.0-ballot - CI Build AU

This page is part of AU Base v4.1.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions

Data Type Profile: AU Local Prescription Identifier

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-localprescriptionidentifier Version: 4.1.0-ballot
Draft as of 2022-11-10 Maturity Level: 2 Computable Name: AULocalPrescriptionIdentifier

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This identifier profile defines a local prescription identifier (sometimes referred to as prescription number) in an Australian context.

A local prescription identifier is an organisation’s identifier for a prescription in that organisation’s local system set of prescriptions.

A local prescription identifier allows linking of a prescription to a system’s local identifier.

Usage Notes

It is preferable that an organisation uses their own local system identifier namespace but if that is not available then an organisation can use their HPI-O to construct a legal globally unique identifier system for their local identifiers.

See the Australian Digital Health Agency’s R4 FAQ for guidance on constructing an HPI-O scoped[1] local prescription identifier.

Usage:

Formal Views of Profile Content

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

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Prescription Identifier
... type 1..1CodeableConceptCoded identifier type for local prescription identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: LPN
... system 1..1uriSystem identifier namespace for the organisation that assigned the prescription identifier
... value 1..1stringPrescription identifier
.... display 1..1stringName of the assigning organisation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Prescription Identifier
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptCoded identifier type for local prescription 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.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: LPN
... system Σ1..1uriSystem identifier namespace for the organisation that assigned the prescription identifier
Example General: http://www.acme.com/identifiers/patient
... assigner Σ1..1Reference(Organization)Organisation that assigned the prescription identifier
.... display Σ1..1stringName of the assigning organisation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: LPN
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Prescription Identifier
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... id0..1idUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: LPN
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system Σ1..1uriSystem identifier namespace for the organisation that assigned the prescription identifier
Example General: http://www.acme.com/identifiers/patient
... value Σ1..1stringPrescription identifier
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ1..1Reference(Organization)Organisation that assigned the prescription identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ1..1stringName of the assigning organisation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: LPN
Identifier.assigner.typeextensibleResourceType

This structure is derived from Identifier

Summary

Mandatory: 5 elements

Maturity: 2

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Prescription Identifier
... type 1..1CodeableConceptCoded identifier type for local prescription identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: LPN
... system 1..1uriSystem identifier namespace for the organisation that assigned the prescription identifier
... value 1..1stringPrescription identifier
.... display 1..1stringName of the assigning organisation

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Prescription Identifier
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptCoded identifier type for local prescription 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.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: LPN
... system Σ1..1uriSystem identifier namespace for the organisation that assigned the prescription identifier
Example General: http://www.acme.com/identifiers/patient
... assigner Σ1..1Reference(Organization)Organisation that assigned the prescription identifier
.... display Σ1..1stringName of the assigning organisation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: LPN

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Prescription Identifier
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... id0..1idUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: LPN
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system Σ1..1uriSystem identifier namespace for the organisation that assigned the prescription identifier
Example General: http://www.acme.com/identifiers/patient
... value Σ1..1stringPrescription identifier
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ1..1Reference(Organization)Organisation that assigned the prescription identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ1..1stringName of the assigning organisation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: LPN
Identifier.assigner.typeextensibleResourceType

This structure is derived from Identifier

Summary

Mandatory: 5 elements

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron

Notes:

none defined