Australian Base Implementation Guide (AU Base 2)

AU Base Implementation Guide, published by HL7 Australia. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

1.0 StructureDefinition-au-medicalrecordnumber

AU Medical Record Number [FMM Level 0]

This identifier profile defines a Medical Record Number (e.g. ABN scoped[1], HPI-O scoped[2]) in an Australian context.

Examples

Patient with interpreter required and language unknown

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

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

This identifier profile defines a medical record number in an Australian context.

This profile builds on Identifier.

This profile was published on Mon Mar 16 00:00:00 UTC 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 0..*IdentifierMedical Record Number (MRN)
... type 1..1CodeableConceptCoded identifier type for MRN
Binding: V2 Identifier Type - AU Extended (required)
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/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
.... text 0..1stringPlain text representation of the concept
Fixed Value: Medical Record Number
... system 1..1uriMedical record number system namespace
... value 1..1stringMedical record number
... assigner 1..1Reference(Organization)Medical record number assigning entity

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierMedical Record Number (MRN)
... 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 ΣI1..1CodeableConceptCoded identifier type for MRN
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
.... 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: Medical Record Number
... system ΣI1..1uriMedical record number system namespace
Example General: http://www.acme.com/identifiers/patient
... value ΣI1..1stringMedical record number
Example General: 123456
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI1..1Reference(Organization)Medical record number assigning entity

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierMedical Record Number (MRN)
... type 1..1CodeableConceptCoded identifier type for MRN
Binding: V2 Identifier Type - AU Extended (required)
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/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
.... text 0..1stringPlain text representation of the concept
Fixed Value: Medical Record Number
... system 1..1uriMedical record number system namespace
... value 1..1stringMedical record number
... assigner 1..1Reference(Organization)Medical record number assigning entity

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierMedical Record Number (MRN)
... 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 ΣI1..1CodeableConceptCoded identifier type for MRN
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
.... 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: Medical Record Number
... system ΣI1..1uriMedical record number system namespace
Example General: http://www.acme.com/identifiers/patient
... value ΣI1..1stringMedical record number
Example General: 123456
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI1..1Reference(Organization)Medical record number assigning entity

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

none defined