This page is part of AU Base v4.0.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions
AU Local Prescription Identifier [FMM 2]
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.
No extensions are used in this profile.
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.
Prescription for Stribild with concurrent supply
Prescription for paracetamol + codeine
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-localprescriptionidentifier
This identifier profile defines a local prescription identifier (sometimes referred to as prescription number) in an Australian context.
This profile builds on Identifier.
This profile was published on 2020-10-09 as a draft by Health Level Seven Australia (Medications WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Identifier | Local Prescription Identifier | |
![]() ![]() ![]() | 1..1 | CodeableConcept | Coded identifier type for local prescription identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LPN | |
![]() ![]() ![]() | 1..1 | uri | System identifier namespace for the organisation that assigned the prescription identifier | |
![]() ![]() ![]() | 1..1 | string | Prescription identifier | |
![]() ![]() ![]() | 1..1 | Reference(Organization) | Organisation that assigned the prescription identifier | |
![]() ![]() ![]() ![]() | 1..1 | string | Name of the assigning organisation | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Identifier | Local Prescription Identifier | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Coded 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 |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LPN | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the prescription identifier Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() | Σ | 1..1 | string | Prescription identifier Example General: 123456 |
![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() | Σ | 1..1 | Reference(Organization) | Organisation that assigned the prescription identifier |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() | Σ | 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). |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Name of the assigning organisation |
![]() |
Differential View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Identifier | Local Prescription Identifier | |
![]() ![]() ![]() | 1..1 | CodeableConcept | Coded identifier type for local prescription identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LPN | |
![]() ![]() ![]() | 1..1 | uri | System identifier namespace for the organisation that assigned the prescription identifier | |
![]() ![]() ![]() | 1..1 | string | Prescription identifier | |
![]() ![]() ![]() | 1..1 | Reference(Organization) | Organisation that assigned the prescription identifier | |
![]() ![]() ![]() ![]() | 1..1 | string | Name of the assigning organisation | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Identifier | Local Prescription Identifier | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Coded 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 |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LPN | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the prescription identifier Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() | Σ | 1..1 | string | Prescription identifier Example General: 123456 |
![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() | Σ | 1..1 | Reference(Organization) | Organisation that assigned the prescription identifier |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() | Σ | 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). |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Name of the assigning organisation |
![]() |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-localprescriptionidentifier
none defined