PrescribeIT® Specification and Guide Version 5.0

 

The official URL for this profile is:

http://prescribeit.ca/fhir/StructureDefinition/dtprofile-identifier-prescription

Download Excel representation

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

>

This structure is derived from Shared Health Identifier

NameCard.TypeConstraints and Usage
.  Identifier 0..*Shared Health IdentifierDefinition:
A technical identifier - identifies some entity uniquely and unambiguously.

..  type 1..1Shared Health CodeableConcept CodeBinding: 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..*CodingSlice: 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..1uriDefinition:
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..1codeDefinition:
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.

...  coding
       (placer)
0..*CodingDefinition:
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..1uriFixed 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..1codeFixed 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

..  system 1..1uriEMR-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..1stringExample' 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*Shared Health IdentifierAn identifier intended for computation
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
.... coding S1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:placer S0..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
... system SI1..1uriThe namespace for the identifier
EMR-id-branch-2: This must be an OID ending in .2
... value S1..1stringThe value that is unique

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*Shared Health IdentifierAn identifier intended for computation
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type S1..1Shared Health CodeableConcept CodeConcept - 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..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional 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..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:placer SΣ0..*CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... system SΣI1..1uriThe 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..1stringThe value that is unique
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Grid View

This structure is derived from Shared Health Identifier

NameCard.TypeConstraints and Usage
.  Identifier 0..*Shared Health IdentifierDefinition:
A technical identifier - identifies some entity uniquely and unambiguously.

..  type 1..1Shared Health CodeableConcept CodeBinding: 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..*CodingSlice: 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..1uriDefinition:
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..1codeDefinition:
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.

...  coding
       (placer)
0..*CodingDefinition:
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..1uriFixed 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..1codeFixed 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

..  system 1..1uriEMR-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..1stringExample' 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*Shared Health IdentifierAn identifier intended for computation
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
.... coding S1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:placer S0..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
... system SI1..1uriThe namespace for the identifier
EMR-id-branch-2: This must be an OID ending in .2
... value S1..1stringThe value that is unique

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*Shared Health IdentifierAn identifier intended for computation
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type S1..1Shared Health CodeableConcept CodeConcept - 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..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional 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..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:placer SΣ0..*CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... system SΣI1..1uriThe 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..1stringThe value that is unique
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Identifier.userequiredIdentifierUse
Identifier.typeextensibleIdentifier Type Codes

Constraints

IdPathDetailsRequirements
EMR-id-branch-2Identifier.systemThis must be an OID ending in .2
: $this.matches('^urn\\:oid\\:(\\d+\\.)+2$')