Shared Health Specification and Guide Version 5.0

 

3.52 StructureDefinition: Shared Health CodeableConcept Required Text with optional code

The official URL for this profile is: 

http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-text-required-with-code

3.52.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 CodeableConcept

NameCard.TypeConstraints and Usage
.  CodeableConcept 0..*CodeableConceptDefinition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

..  coding 0..1CodingDefinition:
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.

...  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

..  text 1..1stringMax Length: 2500
Definition:
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.


Comments:
Conformance Rule: This is the text used to convey the exact word that was displayed to the practitioner

This structure is derived from CodeableConcept

Summary

Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 5 elements

This structure is derived from CodeableConcept

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeableConcept 0..*CodeableConceptConcept - reference to a terminology or just text
... coding S0..1CodingCode defined by a terminology system
.... system S1..1uriIdentity of the terminology system
.... code S1..1codeSymbol in syntax defined by the system
.... display S0..1stringRepresentation defined by the system
... text S1..1stringPlain text representation of the concept
Max Length: 2500

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeableConcept 0..*CodeableConceptConcept - reference to a terminology or just text
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... coding SΣ0..1CodingCode 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
.... version Σ0..1stringVersion of the system - if relevant
.... code SΣ1..1codeSymbol in syntax defined by the system
.... display SΣ0..1stringRepresentation defined by the system
.... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... text SΣ1..1stringPlain text representation of the concept
Max Length: 2500

doco Documentation for this format

Grid View

This structure is derived from CodeableConcept

NameCard.TypeConstraints and Usage
.  CodeableConcept 0..*CodeableConceptDefinition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

..  coding 0..1CodingDefinition:
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.

...  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

..  text 1..1stringMax Length: 2500
Definition:
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.


Comments:
Conformance Rule: This is the text used to convey the exact word that was displayed to the practitioner

This structure is derived from CodeableConcept

Summary

Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 5 elements

Differential View

This structure is derived from CodeableConcept

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeableConcept 0..*CodeableConceptConcept - reference to a terminology or just text
... coding S0..1CodingCode defined by a terminology system
.... system S1..1uriIdentity of the terminology system
.... code S1..1codeSymbol in syntax defined by the system
.... display S0..1stringRepresentation defined by the system
... text S1..1stringPlain text representation of the concept
Max Length: 2500

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeableConcept 0..*CodeableConceptConcept - reference to a terminology or just text
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... coding SΣ0..1CodingCode 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
.... version Σ0..1stringVersion of the system - if relevant
.... code SΣ1..1codeSymbol in syntax defined by the system
.... display SΣ0..1stringRepresentation defined by the system
.... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... text SΣ1..1stringPlain text representation of the concept
Max Length: 2500

doco Documentation for this format

 

Other representations of profile: Schematron

3.52.3 Terminology Bindings

3.52.4 Constraints

Constraints

IdPathDetailsRequirements