PrescribeIT™ Specification and Guide Version 2.0 Revision F

 

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..*Definition:
A technical identifier - identifies some entity uniquely and unambiguously.

..  type 1..1Shared Health CodeableConcept CodeBinding: Identifier Type Codes (extensible)
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:
....  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).

...  coding
       (placer)
1..*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..1uriExample' 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.

..  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:
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

This structure is derived from Shared Health Identifier

Summary

Mandatory: 5 elements
Must-Support: 6 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 S0..*
... type S1..1Shared Health CodeableConcept Code
.... coding SCodingSlice: Unordered, Open by value:system, value:code
.... coding S1..*Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/identifier-type
..... code S1..1codeFixed Value: PLAC
... value S1..1string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier S0..*An 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)
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: Identifier Type Codes (extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... 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 SΣ1..*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Σ1..1uriThe namespace for the identifier
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..*Definition:
A technical identifier - identifies some entity uniquely and unambiguously.

..  type 1..1Shared Health CodeableConcept CodeBinding: Identifier Type Codes (extensible)
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:
....  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).

...  coding
       (placer)
1..*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..1uriExample' 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.

..  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:
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

This structure is derived from Shared Health Identifier

Summary

Mandatory: 5 elements
Must-Support: 6 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 S0..*
... type S1..1Shared Health CodeableConcept Code
.... coding SCodingSlice: Unordered, Open by value:system, value:code
.... coding S1..*Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/identifier-type
..... code S1..1codeFixed Value: PLAC
... value S1..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier S0..*An 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)
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: Identifier Type Codes (extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... 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 SΣ1..*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Σ1..1uriThe namespace for the identifier
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

PathNameConformanceValueSet
Identifier.useIdentifierUserequiredIdentifierUse
Identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes

Constraints

IdPathDetailsRequirements