AU Base Implementation Guide
4.2.2-ci-build - CI Build
AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 4.2.2-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. 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
Official URL: http://hl7.org.au/fhir/StructureDefinition/au-etpprescriptionidentifier | Version: 4.2.2-ci-build | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: AUETPPrescriptionIdentifier | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
This identifier profile defines an Electronic Transfer of Prescription (ETP) prescription identifier in an Australian context. An ETP prescription identifier is assigned to a prescription by an ETP vendor, e.g. ERx or Medisecure, and is the assigned numeric value of the barcode on a prescription instance.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Identifier
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Electronic Transfer of Prescription (ETP) Prescription Identifier | |
type | 1..1 | CodeableConcept | Coded identifier type for ETP prescription identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ETP | |
system | 1..1 | uri | System identifier namespace for the ETP vendor that assigned the identifier | |
value | 1..1 | string | ETP prescription identifier | |
assigner | 1..1 | Reference(Organization) | ETP vendor | |
display | 1..1 | string | ETP vendor's name | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Electronic Transfer of Prescription (ETP) Prescription Identifier | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Coded identifier type for ETP 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 |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ETP | |
system | Σ | 1..1 | uri | System identifier namespace for the ETP vendor that assigned the identifier Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | ETP prescription identifier Example General: 123456 |
assigner | Σ | 1..1 | Reference(Organization) | ETP vendor |
display | Σ | 1..1 | string | ETP vendor's name |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Identifier.type | extensible | Pattern: ETPhttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Electronic Transfer of Prescription (ETP) Prescription Identifier | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Coded identifier type for ETP 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 |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ETP | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
system | Σ | 1..1 | uri | System identifier namespace for the ETP vendor that assigned the identifier Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | ETP prescription identifier Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 1..1 | Reference(Organization) | ETP vendor |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 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). |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
display | Σ | 1..1 | string | ETP vendor's name |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Identifier.type | extensible | Pattern: ETPhttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Identifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Identifier
Differential View
This structure is derived from Identifier
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Electronic Transfer of Prescription (ETP) Prescription Identifier | |
type | 1..1 | CodeableConcept | Coded identifier type for ETP prescription identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ETP | |
system | 1..1 | uri | System identifier namespace for the ETP vendor that assigned the identifier | |
value | 1..1 | string | ETP prescription identifier | |
assigner | 1..1 | Reference(Organization) | ETP vendor | |
display | 1..1 | string | ETP vendor's name | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Electronic Transfer of Prescription (ETP) Prescription Identifier | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Coded identifier type for ETP 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 |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ETP | |
system | Σ | 1..1 | uri | System identifier namespace for the ETP vendor that assigned the identifier Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | ETP prescription identifier Example General: 123456 |
assigner | Σ | 1..1 | Reference(Organization) | ETP vendor |
display | Σ | 1..1 | string | ETP vendor's name |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Identifier.type | extensible | Pattern: ETPhttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Electronic Transfer of Prescription (ETP) Prescription Identifier | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Coded identifier type for ETP 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 |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ETP | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
system | Σ | 1..1 | uri | System identifier namespace for the ETP vendor that assigned the identifier Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | ETP prescription identifier Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 1..1 | Reference(Organization) | ETP vendor |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 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). |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
display | Σ | 1..1 | string | ETP vendor's name |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Identifier.type | extensible | Pattern: ETPhttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Identifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Identifier
Other representations of profile: CSV, Excel, Schematron