Australian Base Implementation Guide

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

1.0 StructureDefinition-au-localorderidentifier

AU Local Order Identifier [FMM 1]

This identifier profile defines a local order identifier in an Australian context. A local order identifier is an organisation’s identifier for an order in that organisation’s local system set of orders.

Typically a local order identifier will be either a placer identifier[1] or a filler identifier[2] (sometimes known as filler order number). A placer identifier is an identifier for a request or group of requests where the identifier is issued by the entity making the request. A filler identifier is an identifier for a request or group of requests where the identifier is issued by the entity that produces the observations or fulfills the request.

Extensions

No extensions are used in this profile.

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 order identifier.

Examples

Hepatitis B surface antibody measurement order

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

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

This identifier profile defines a local order identifier in an Australian context. A local order identifier is an organisation's identifier for an order in that organisation's local system set of orders.

This profile builds on Identifier.

This profile was published on 2022-04-04 as a active by Health Level Seven Australia (Orders and Observations WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Order Identifier
... type 1..1CodeableConceptCoded identifier type for local order identifier
Binding: Order Identifier Type (required)
... system 1..1uriSystem identifier namespace for the organisation that assigned the order identifier
... value 1..1stringOrder identifier
... assigner 1..1Reference(Organization)Organisation that assigned the order identifier
.... display 1..1stringName of the assigning organisation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Order 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 .

... type Σ1..1CodeableConceptCoded identifier type for local order identifier
Binding: Order Identifier Type (required)
... system Σ1..1uriSystem identifier namespace for the organisation that assigned the order identifier
Example General: http://www.acme.com/identifiers/patient
... value Σ1..1stringOrder identifier
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ1..1Reference(Organization)Organisation that assigned the order identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Order Identifier
... type 1..1CodeableConceptCoded identifier type for local order identifier
Binding: Order Identifier Type (required)
... system 1..1uriSystem identifier namespace for the organisation that assigned the order identifier
... value 1..1stringOrder identifier
... assigner 1..1Reference(Organization)Organisation that assigned the order identifier
.... display 1..1stringName of the assigning organisation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Order 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 .

... type Σ1..1CodeableConceptCoded identifier type for local order identifier
Binding: Order Identifier Type (required)
... system Σ1..1uriSystem identifier namespace for the organisation that assigned the order identifier
Example General: http://www.acme.com/identifiers/patient
... value Σ1..1stringOrder identifier
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ1..1Reference(Organization)Organisation that assigned the order identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..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

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-localorderidentifier

none defined

Issues & Feedback