GenderIdentityExtension
The FHIR extension is for Immunization AEFI Status purposes.
GenderIdentityExtension (Extension) | I | Extension | |
id | 0..0 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 0..1 | ||
valueCodeableConcept | CodeableConcept | ||
id | 0..0 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
text | Σ | 0..1 | string |
Extension | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...0 |
Type | string |
Mappings |
|
Extension.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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 Value | http://hl7.org/fhir/StructureDefinition/patient-genderIdentity |
Mappings |
|
Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...1 |
Type | CodeableConcept |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...0 |
Type | string |
Mappings |
|
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.value[x].coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Summary | True |
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. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.value[x].coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...0 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
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). |
Cardinality | 1...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Extension.value[x].coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
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). |
Cardinality | 0...0 |
Type | boolean |
Summary | True |
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. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 | Mandatory if CODE = 3131-1 (Other Gender). See Mappings. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <url value="http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" /> <name value="GenderIdentityExtension" /> <status value="draft" /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Patient" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension.id"> <path value="Extension.id" /> <max value="0" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <type> <code value="CodeableConcept" /> </type> </element> <element id="Extension.value[x].id"> <path value="Extension.value[x].id" /> <max value="0" /> </element> <element id="Extension.value[x].coding"> <path value="Extension.value[x].coding" /> <min value="1" /> <max value="1" /> </element> <element id="Extension.value[x].coding.system"> <path value="Extension.value[x].coding.system" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" /> </mapping> </element> <element id="Extension.value[x].coding.version"> <path value="Extension.value[x].coding.version" /> <max value="0" /> </element> <element id="Extension.value[x].coding.code"> <path value="Extension.value[x].coding.code" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="CLIENT.HUMAN_SUBJECT.GENDER_IDENTITY_CODED_CNCPT_ID" /> </mapping> </element> <element id="Extension.value[x].coding.userSelected"> <path value="Extension.value[x].coding.userSelected" /> <max value="0" /> </element> <element id="Extension.value[x].text"> <path value="Extension.value[x].text" /> <comment value="Mandatory if CODE = 3131-1 (Other Gender). See Mappings." /> <mapping> <identity value="source-PIR" /> <map value="CLIENT.HUMAN_SUBJECT.GENDER_IDENTITY_OTHER" /> </mapping> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "url": "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity", "name": "GenderIdentityExtension", "status": "draft", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension.id", "path": "Extension.id", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "type": [ { "code": "CodeableConcept" } ] }, { "id": "Extension.value[x].id", "path": "Extension.value[x].id", "max": "0" }, { "id": "Extension.value[x].coding", "path": "Extension.value[x].coding", "min": 1, "max": "1" }, { "id": "Extension.value[x].coding.system", "path": "Extension.value[x].coding.system", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" } ] }, { "id": "Extension.value[x].coding.version", "path": "Extension.value[x].coding.version", "max": "0" }, { "id": "Extension.value[x].coding.code", "path": "Extension.value[x].coding.code", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "CLIENT.HUMAN_SUBJECT.GENDER_IDENTITY_CODED_CNCPT_ID" } ] }, { "id": "Extension.value[x].coding.userSelected", "path": "Extension.value[x].coding.userSelected", "max": "0" }, { "id": "Extension.value[x].text", "path": "Extension.value[x].text", "comment": "Mandatory if CODE = 3131-1 (Other Gender). See Mappings.", "mapping": [ { "identity": "source-PIR", "map": "CLIENT.HUMAN_SUBJECT.GENDER_IDENTITY_OTHER" } ] } ] } }