Interoperabilidad de Historia Clínica - Colombia
0.4.2 - ci-build Colombia flag

Interoperabilidad de Historia Clínica - Colombia - Local Development build (v0.4.2). See the Directory of published versions

Extension: TipoAlergia - Detailed Descriptions

Draft as of 2023-10-31

Definitions for the co-AllergyIntolerance-tipo extension.

Guidance on how to interpret the contents of this table can be found here.

1. Extension
Definition

Extensión utilizada para representar el tipo de la alergía.

Optional Extension Element - found in all resources.

2. Extension.extension
Control0..0*
3. Extension.url
Must Supporttrue
Fixed Valuehttps://www.minsalud.gov.co/ihc/fhir/StructureDefinition/co-AllergyIntolerance-tipo
4. Extension.value[x]
Control10..1
BindingThe codes SHALL be taken from Tipo AlergiaFor codes, see (unbound)
TypeChoice of: , date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
5. Extension.value[x].coding
Control1..1
Must Supporttrue
6. Extension.value[x].coding.system
Control0..?
Must Supporttrue
7. Extension.value[x].coding.code
Control1..?
Must Supporttrue
8. Extension.value[x].coding.display
Control0..?
Must Supporttrue
9. Extension.value[x].text
Control0..?
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here.

1. Extension
Definition

Extensión utilizada para representar el tipo de la alergía.

Optional Extension Element - found in all resources.

Control0..* This element is affected by the following invariants: ele-1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
2. Extension.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..0*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Must Supporttrue
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttps://www.minsalud.gov.co/ihc/fhir/StructureDefinition/co-AllergyIntolerance-tipo
4. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control10..1
BindingThe codes SHALL be taken from Tipo AlergiaFor codes, see (unbound)
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Extension.value[x].coding
Definition

A reference to a code defined by a terminology system.

Control10..1*
TypeCoding
Must Supporttrue
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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 labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Extension.value[x].coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Extension.value[x].coding.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).

Control10..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Extension.value[x].coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Obligations
Obligations
??
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Extension.value[x].text
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.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Obligations
Obligations
??
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. Extension
Definition

Extensión utilizada para representar el tipo de la alergía.

Control0..* This element is affected by the following invariants: ele-1
2. Extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
3. Extension.extension
Definition

An Extension

Control0..0
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Must Supporttrue
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttps://www.minsalud.gov.co/ihc/fhir/StructureDefinition/co-AllergyIntolerance-tipo
5. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control1..1
BindingThe codes SHALL be taken from Tipo Alergia
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summaryfalse
6. Extension.value[x].id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
7. Extension.value[x].extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
8. Extension.value[x].coding
Definition

A reference to a code defined by a terminology system.

Control1..1
TypeCoding
Must Supporttrue
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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 labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Extension.value[x].coding.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
10. Extension.value[x].coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.value[x].coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
11. Extension.value[x].coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Extension.value[x].coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Extension.value[x].coding.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).

Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Extension.value[x].coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Obligations
Obligations
??
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Extension.value[x].coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Extension.value[x].text
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.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Obligations
Obligations
??
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))