3.75 StructureDefinition: PrescribeIT® Prescriber Prescription Identifier
The official URL for this profile is:
http://prescribeit.ca/fhir/StructureDefinition/dtprofile-identifier-prescription
3.75.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Shared Health Identifier
Name | Card. | Type | Constraints and Usage |
---|---|---|---|
Identifier | 0..* | Shared Health Identifier | Definition: A technical identifier - identifies some entity uniquely and unambiguously. |
type | 1..1 | Shared Health CodeableConcept Code | 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. Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: |
coding | 1..* | Coding | Slice: Unordered, Open by value:system, value:code Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: This is the code as defined within the binding. |
display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
coding (placer) | 0..* | Coding | Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
system | 1..1 | uri | Fixed Value: http://hl7.org/fhir/identifier-type Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: http://hl7.org/fhir/identifier-type |
code | 1..1 | code | Fixed Value: PLAC Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: Fixed value: PLAC |
display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
system | 1..1 | uri | EMR-id-branch-2: This must be an OID ending in .2 Example' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri Definition: Establishes the namespace in which set of possible id values is unique. Comments: Conformance Rule: This must be an OID of the URI form [Vendor root].[Application instance node].2 (e.g. urn:oid:1.2.3.4). The branch, “.2” is appended to create a unique namespace for the Prescription Identifer |
value | 1..1 | string | Example' General': 123456 Definition: The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments: Usage Rule: The business identifier that uniquely identifies a prescription. |
This structure is derived from Shared Health Identifier
Summary
Mandatory: 4 elements (2 nested mandatory elements)
Must-Support: 7 elements
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element Identifier.type.coding is sliced based on the values of value:system, value:code
This structure is derived from Shared Health Identifier
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Shared Health Identifier | An identifier intended for computation | |
type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text |
coding | S | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code |
coding:placer | S | 0..* | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type |
code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC |
system | SI | 1..1 | uri | The namespace for the identifier EMR-id-branch-2: This must be an OID ending in .2 |
value | S | 1..1 | string | The value that is unique |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Shared Health Identifier | An identifier intended for computation | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text 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. |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | SΣ | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code |
coding:All Slices | Content/Rules for all slices | |||
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | SΣ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
coding:placer | SΣ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC |
display | SΣ | 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 | SΣI | 1..1 | uri | The namespace for the identifier EMR-id-branch-2: This must be an OID ending in .2 Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
Documentation for this format |
Grid View
This structure is derived from Shared Health Identifier
Name | Card. | Type | Constraints and Usage |
---|---|---|---|
Identifier | 0..* | Shared Health Identifier | Definition: A technical identifier - identifies some entity uniquely and unambiguously. |
type | 1..1 | Shared Health CodeableConcept Code | 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. Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: |
coding | 1..* | Coding | Slice: Unordered, Open by value:system, value:code Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: This is the code as defined within the binding. |
display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
coding (placer) | 0..* | Coding | Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
system | 1..1 | uri | Fixed Value: http://hl7.org/fhir/identifier-type Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: http://hl7.org/fhir/identifier-type |
code | 1..1 | code | Fixed Value: PLAC Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: Fixed value: PLAC |
display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
system | 1..1 | uri | EMR-id-branch-2: This must be an OID ending in .2 Example' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri Definition: Establishes the namespace in which set of possible id values is unique. Comments: Conformance Rule: This must be an OID of the URI form [Vendor root].[Application instance node].2 (e.g. urn:oid:1.2.3.4). The branch, “.2” is appended to create a unique namespace for the Prescription Identifer |
value | 1..1 | string | Example' General': 123456 Definition: The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments: Usage Rule: The business identifier that uniquely identifies a prescription. |
This structure is derived from Shared Health Identifier
Summary
Mandatory: 4 elements (2 nested mandatory elements)
Must-Support: 7 elements
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element Identifier.type.coding is sliced based on the values of value:system, value:code
Differential View
This structure is derived from Shared Health Identifier
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Shared Health Identifier | An identifier intended for computation | |
type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text |
coding | S | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code |
coding:placer | S | 0..* | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type |
code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC |
system | SI | 1..1 | uri | The namespace for the identifier EMR-id-branch-2: This must be an OID ending in .2 |
value | S | 1..1 | string | The value that is unique |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Shared Health Identifier | An identifier intended for computation | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text 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. |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | SΣ | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code |
coding:All Slices | Content/Rules for all slices | |||
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | SΣ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
coding:placer | SΣ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC |
display | SΣ | 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 | SΣI | 1..1 | uri | The namespace for the identifier EMR-id-branch-2: This must be an OID ending in .2 Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
Documentation for this format |
Other representations of profile: Schematron
3.75.3 Terminology Bindings
Terminology Bindings
Path | Conformance | ValueSet |
Identifier.use | required | IdentifierUse |
Identifier.type | extensible | Identifier Type Codes |
3.75.4 Constraints
Constraints
Id | Path | Details | Requirements |
EMR-id-branch-2 | Identifier.system | This must be an OID ending in .2 : $this.matches('^urn\\:oid\\:(\\d+\\.)+2$') |