Work in progress.
This section of the Implementation Guide is subject to change.

Extensions Index

This extension library contains all the extensions Clinically and Technically Assurance for use with EE Base. It also includes some HL7 common extensions which are suitable for use with the EE Base Profiles. The profiles are found in the Profiles Index. The table below lists all the current extensions and the context of use. The context of use column indicates the profile and /or element where the extension may be applied. The modifierExtension column indicates whether the extension is an modifierExtension or not. The general rule is extensions can be ignored by receivers. When a modifierExtension is received it MUST NOT be ignored as it modifies the meaning of the element or elements that contains it. Typically, this means information that qualifies or negates the primary meaning of the element that contains it.

See for more information from HL7 about FHIR extensions and FHIR modifierExtensions.


All the extensions have been assured as suitable for inclusion in the EE Base:
Extension Status Context of Use Related EEBase Profiles modifierExtension
Extension EeBase ADS active Address All address fields in EEBase profiles No
Extension EeBase EHAK active Address All address fields in EEBase profiles No
HL7 Common Extensions
Extension encounter-modeOfArrival draft Encounter Profile EEBaseEncounter No
Extension encounter-associatedEncounter draft Encounter Profile EEBaseEncounter No

StructureDefinition Extension-EeBase-ADS

This carries an address key which will be included in an address.

http://hl7.ee/id/ads-number should be used as coding system.

Purpose

This extension extends the Address datatype to support the exchange of the type of address key and the address key value, which are currently not supported by the FHIR standard.


Snapshot View

id0..1string
extensionI0..*Extension
url1..1uriFixed Value
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean

Differential View

id0..1string
extensionI0..*Extension
url1..1uriFixed Value
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean

Hybrid View

id0..1string
extensionI0..*Extension
url1..1uriFixed Value
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean

Table View

Extension..
Extension.url..
Extension.value[x]Coding..
Extension.value[x].system1..
Extension.value[x].code1..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-EEBase-ADS" />
    <meta>
        <lastUpdated value="2022-11-01T09:34:11.3138271+00:00" />
    </meta>
    <url value="https://hl7.ee/fhir/StructureDefinition/Extension-EEBase-ADS" />
    <version value="1.0.0" />
    <name value="ExtensionEEBaseADS" />
    <title value="EEBase ADS extension" />
    <status value="draft" />
    <date value="2022-11-01T09:34:27.108444+00:00" />
    <publisher value="HL7 EE" />
    <fhirVersion value="4.0.1" />
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="Address" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="ADS extension" />
            <definition value="Aadressiandmete s&#252;steem (ADS) koosneb aadressiandmete s&#252;steemi infos&#252;steemist ning erinevatest n&#245;uetest. ADS-i eesm&#228;rk on tagada &#252;hene aadressiandmete kogumine, registreerimine, t&#246;&#246;tlemine, s&#228;ilitamine, identifitseerimine ning t&#246;&#246;tlemise funktsioonide &#252;hetaoline korraldamine." />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://hl7.ee/fhir/StructureDefinition/Extension-EEBase-ADS" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <type>
                <code value="Coding" />
            </type>
        </element>
        <element id="Extension.value[x].system">
            <path value="Extension.value[x].system" />
            <short value="Reference to ADR-ID (identifier of address object and its version)" />
            <definition value="https://geoportaal.maaamet.ee/est/Ruumiandmed/Aadressiandmed-p112.html" />
            <min value="1" />
            <fixedUri value="https://hl7.ee/fhir/NamingSystem/ads-id" />
        </element>
        <element id="Extension.value[x].code">
            <path value="Extension.value[x].code" />
            <min value="1" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-EEBase-ADS",
    "meta": {
        "lastUpdated": "2022-11-01T09:34:11.3138271+00:00"
    },
    "url": "https://hl7.ee/fhir/StructureDefinition/Extension-EEBase-ADS",
    "version": "1.0.0",
    "name": "ExtensionEEBaseADS",
    "title": "EEBase ADS extension",
    "status": "draft",
    "date": "2022-11-01T09:34:27.108444+00:00",
    "publisher": "HL7 EE",
    "fhirVersion": "4.0.1",
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "Address"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "ADS extension",
                "definition": "Aadressiandmete süsteem (ADS) koosneb aadressiandmete süsteemi infosüsteemist ning erinevatest nõuetest. ADS-i eesmärk on tagada ühene aadressiandmete kogumine, registreerimine, töötlemine, säilitamine, identifitseerimine ning töötlemise funktsioonide ühetaoline korraldamine."
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://hl7.ee/fhir/StructureDefinition/Extension-EEBase-ADS"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "type":  [
                    {
                        "code": "Coding"
                    }
                ]
            },
            {
                "id": "Extension.value[x].system",
                "path": "Extension.value[x].system",
                "short": "Reference to ADR-ID (identifier of address object and its version)",
                "definition": "https://geoportaal.maaamet.ee/est/Ruumiandmed/Aadressiandmed-p112.html",
                "min": 1,
                "fixedUri": "https://hl7.ee/fhir/NamingSystem/ads-id"
            },
            {
                "id": "Extension.value[x].code",
                "path": "Extension.value[x].code",
                "min": 1
            }
        ]
    }
}



StructureDefinition Extension-EeBase-EHAK

This carries an administrative division code which will be included in an address.

http://hl7.ee/id/ehak-number should be used as coding system.

Purpose

This extension extends the Address datatype to support the exchange of the type of address code and the address code value, which are currently not supported by the FHIR standard.


Snapshot View

id0..1string
extensionI0..*Extension
url1..1uriFixed Value
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean

Differential View

id0..1string
extensionI0..*Extension
url1..1uriFixed Value
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean

Hybrid View

id0..1string
extensionI0..*Extension
url1..1uriFixed Value
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean

Table View

Extension..
Extension.url..
Extension.value[x]Coding..
Extension.value[x].system1..
Extension.value[x].code1..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-EEBase-EHAK" />
    <meta>
        <lastUpdated value="2022-11-01T09:36:29.2488885+00:00" />
    </meta>
    <url value="https://hl7.ee/fhir/StructureDefinition/Extension-EEBase-EHAK" />
    <version value="1.0.0" />
    <name value="ExtensionEEBaseEHAK" />
    <title value="EEBase EHAK extension" />
    <status value="draft" />
    <date value="2022-11-01T09:36:39.808201+00:00" />
    <publisher value="HL7 EE" />
    <fhirVersion value="4.0.1" />
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="Address" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="EHAK extension" />
            <definition value="Eesti haldus- ja asustusjaotuse klassifikaator (EHAK) on ette n&#228;htud territoriaalse paiknemise t&#228;histamiseks. Igale klassifitseerimisobjektile on antud unikaalne neljakohaline kood ja n&#228;idatud on objekti nimi ning r&#246;&#246;pnimi (kui see on olemas)." />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://hl7.ee/fhir/StructureDefinition/Extension-EEBase-EHAK" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <type>
                <code value="Coding" />
            </type>
        </element>
        <element id="Extension.value[x].system">
            <path value="Extension.value[x].system" />
            <short value="Reference to EHAK classifier" />
            <comment value="HL7 V3 OID puus registreeritud v&#228;&#228;rtusena 1.3.6.1.4.1.28284.6.2.3.2" />
            <min value="1" />
            <fixedUri value="https://hl7.ee/fhir/NamingSystem/ehak-id" />
        </element>
        <element id="Extension.value[x].code">
            <path value="Extension.value[x].code" />
            <min value="1" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-EEBase-EHAK",
    "meta": {
        "lastUpdated": "2022-11-01T09:36:29.2488885+00:00"
    },
    "url": "https://hl7.ee/fhir/StructureDefinition/Extension-EEBase-EHAK",
    "version": "1.0.0",
    "name": "ExtensionEEBaseEHAK",
    "title": "EEBase EHAK extension",
    "status": "draft",
    "date": "2022-11-01T09:36:39.808201+00:00",
    "publisher": "HL7 EE",
    "fhirVersion": "4.0.1",
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "Address"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "EHAK extension",
                "definition": "Eesti haldus- ja asustusjaotuse klassifikaator (EHAK) on ette nähtud territoriaalse paiknemise tähistamiseks. Igale klassifitseerimisobjektile on antud unikaalne neljakohaline kood ja näidatud on objekti nimi ning rööpnimi (kui see on olemas)."
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://hl7.ee/fhir/StructureDefinition/Extension-EEBase-EHAK"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "type":  [
                    {
                        "code": "Coding"
                    }
                ]
            },
            {
                "id": "Extension.value[x].system",
                "path": "Extension.value[x].system",
                "short": "Reference to EHAK classifier",
                "comment": "HL7 V3 OID puus registreeritud väärtusena 1.3.6.1.4.1.28284.6.2.3.2",
                "min": 1,
                "fixedUri": "https://hl7.ee/fhir/NamingSystem/ehak-id"
            },
            {
                "id": "Extension.value[x].code",
                "path": "Extension.value[x].code",
                "min": 1
            }
        ]
    }
}



StructureDefinition Extension encounter-modeOfArrival

Identifies how a patient arrives at the reporting facility.

Snapshot View

id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueCodingCoding

Differential View

id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueCodingCoding

Hybrid View

id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueCodingCoding

Table View

Extension0..1
Extension.idstring0..1
Extension.extensionExtension0..0
Extension.urluri1..1
Extension.value[x]Coding1..1

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="encounter-modeOfArrival" />
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="1" />
    </extension>
    <url value="http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival" />
    <version value="4.0.1" />
    <name value="modeOfArrival" />
    <title value="modeOfArrival" />
    <status value="draft" />
    <date value="2015-02-21" />
    <publisher value="Health Level Seven, Inc. - FHIR WG" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="HL7" />
        </telecom>
    </contact>
    <description value="Identifies whether a patient arrives at the reporting facility via ambulance and the type of ambulance that was used." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="Encounter" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <snapshot>
        <element id="Extension">
            <path value="Extension" />
            <short value="The method of arrival of the patient into the facility" />
            <definition value="Identifies whether a patient arrives at the reporting facility via ambulance and the type of ambulance that was used." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Extension" />
                <min value="0" />
                <max value="*" />
            </base>
            <condition value="ele-1" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <xpath value="@value|f:*|h:div" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &#39;value&#39;)])" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="false" />
        </element>
        <element id="Extension.id">
            <path value="Extension.id" />
            <representation value="xmlAttr" />
            <short value="Unique id for inter-element referencing" />
            <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Element.id" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
                    <valueUrl value="string" />
                </extension>
                <code value="http://hl7.org/fhirpath/System.String" />
            </type>
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <description value="Extensions are always sliced by (at least) url" />
                <rules value="open" />
            </slicing>
            <short value="Extension" />
            <definition value="An Extension" />
            <min value="0" />
            <max value="0" />
            <base>
                <path value="Element.extension" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="Extension" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <xpath value="@value|f:*|h:div" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="false" />
            <isSummary value="false" />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <representation value="xmlAttr" />
            <short value="identifies the meaning of the extension" />
            <definition value="Source of the definition for the extension code - a logical name or a URL." />
            <comment value="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." />
            <min value="1" />
            <max value="1" />
            <base>
                <path value="Extension.url" />
                <min value="1" />
                <max value="1" />
            </base>
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
                    <valueUrl value="uri" />
                </extension>
                <code value="http://hl7.org/fhirpath/System.String" />
            </type>
            <fixedUri value="http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival" />
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <short value="Value of extension" />
            <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list)." />
            <min value="1" />
            <max value="1" />
            <base>
                <path value="Extension.value[x]" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="Coding" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <xpath value="@value|f:*|h:div" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <isModifier value="false" />
            <isSummary value="false" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="modeOfArrival" />
                </extension>
                <strength value="example" />
                <description value="The method that the patient arrived at the facility." />
                <valueSet value="http://terminology.hl7.org/ValueSet/v2-0430" />
            </binding>
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
        </element>
    </snapshot>
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="The method of arrival of the patient into the facility" />
            <definition value="Identifies whether a patient arrives at the reporting facility via ambulance and the type of ambulance that was used." />
            <min value="0" />
            <max value="1" />
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <max value="0" />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <min value="1" />
            <type>
                <code value="Coding" />
            </type>
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="modeOfArrival" />
                </extension>
                <strength value="example" />
                <description value="The method that the patient arrived at the facility." />
                <valueSet value="http://terminology.hl7.org/ValueSet/v2-0430" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "encounter-modeOfArrival",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 1
        }
    ],
    "url": "http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival",
    "version": "4.0.1",
    "name": "modeOfArrival",
    "title": "modeOfArrival",
    "status": "draft",
    "date": "2015-02-21",
    "publisher": "Health Level Seven, Inc. - FHIR WG",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "HL7"
                }
            ]
        }
    ],
    "description": "Identifies whether a patient arrives at the reporting facility via ambulance and the type of ambulance that was used.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        }
    ],
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "Encounter"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "snapshot": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "The method of arrival of the patient into the facility",
                "definition": "Identifies whether a patient arrives at the reporting facility via ambulance and the type of ambulance that was used.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Extension",
                    "min": 0,
                    "max": "*"
                },
                "condition":  [
                    "ele-1"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "xpath": "@value|f:*|h:div",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Extension.id",
                "path": "Extension.id",
                "representation":  [
                    "xmlAttr"
                ],
                "short": "Unique id for inter-element referencing",
                "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Element.id",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                                "valueUrl": "string"
                            }
                        ],
                        "code": "http://hl7.org/fhirpath/System.String"
                    }
                ],
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    }
                ]
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "description": "Extensions are always sliced by (at least) url",
                    "rules": "open"
                },
                "short": "Extension",
                "definition": "An Extension",
                "min": 0,
                "max": "0",
                "base": {
                    "path": "Element.extension",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "Extension"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "xpath": "@value|f:*|h:div",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": false,
                "isSummary": false
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "representation":  [
                    "xmlAttr"
                ],
                "short": "identifies the meaning of the extension",
                "definition": "Source of the definition for the extension code - a logical name or a URL.",
                "comment": "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.",
                "min": 1,
                "max": "1",
                "base": {
                    "path": "Extension.url",
                    "min": 1,
                    "max": "1"
                },
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                                "valueUrl": "uri"
                            }
                        ],
                        "code": "http://hl7.org/fhirpath/System.String"
                    }
                ],
                "fixedUri": "http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival",
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "N/A"
                    }
                ]
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "short": "Value of extension",
                "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list).",
                "min": 1,
                "max": "1",
                "base": {
                    "path": "Extension.value[x]",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "Coding"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "xpath": "@value|f:*|h:div",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "isModifier": false,
                "isSummary": false,
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "modeOfArrival"
                        }
                    ],
                    "strength": "example",
                    "description": "The method that the patient arrived at the facility.",
                    "valueSet": "http://terminology.hl7.org/ValueSet/v2-0430"
                },
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "N/A"
                    }
                ]
            }
        ]
    },
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "The method of arrival of the patient into the facility",
                "definition": "Identifies whether a patient arrives at the reporting facility via ambulance and the type of ambulance that was used.",
                "min": 0,
                "max": "1"
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "max": "0"
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "Coding"
                    }
                ],
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "modeOfArrival"
                        }
                    ],
                    "strength": "example",
                    "description": "The method that the patient arrived at the facility.",
                    "valueSet": "http://terminology.hl7.org/ValueSet/v2-0430"
                }
            }
        ]
    }
}



StructureDefinition Extension encounter-associatedEncounter

This encounter occurs within the scope of the referenced encounter.

Snapshot View

id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueReferenceReference(Encounter)

Differential View

id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueReferenceReference(Encounter)

Hybrid View

id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueReferenceReference(Encounter)

Table View

Extension0..1
Extension.idstring0..1
Extension.extensionExtension0..0
Extension.urluri1..1
Extension.value[x]Reference(Encounter)1..1

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="encounter-associatedEncounter" />
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="1" />
    </extension>
    <url value="http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter" />
    <version value="4.0.1" />
    <name value="associatedEncounter" />
    <title value="associatedEncounter" />
    <status value="draft" />
    <date value="2015-02-21" />
    <publisher value="Health Level Seven, Inc. - FHIR WG" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="HL7" />
        </telecom>
    </contact>
    <description value="This encounter occurs within the scope of the referenced encounter." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="Encounter" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <snapshot>
        <element id="Extension">
            <path value="Extension" />
            <short value="Associated Encounter" />
            <definition value="This encounter occurs within the scope of the referenced encounter." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Extension" />
                <min value="0" />
                <max value="*" />
            </base>
            <condition value="ele-1" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <xpath value="@value|f:*|h:div" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &#39;value&#39;)])" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="false" />
        </element>
        <element id="Extension.id">
            <path value="Extension.id" />
            <representation value="xmlAttr" />
            <short value="Unique id for inter-element referencing" />
            <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Element.id" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
                    <valueUrl value="string" />
                </extension>
                <code value="http://hl7.org/fhirpath/System.String" />
            </type>
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <description value="Extensions are always sliced by (at least) url" />
                <rules value="open" />
            </slicing>
            <short value="Extension" />
            <definition value="An Extension" />
            <min value="0" />
            <max value="0" />
            <base>
                <path value="Element.extension" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="Extension" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <xpath value="@value|f:*|h:div" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="false" />
            <isSummary value="false" />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <representation value="xmlAttr" />
            <short value="identifies the meaning of the extension" />
            <definition value="Source of the definition for the extension code - a logical name or a URL." />
            <comment value="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." />
            <min value="1" />
            <max value="1" />
            <base>
                <path value="Extension.url" />
                <min value="1" />
                <max value="1" />
            </base>
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
                    <valueUrl value="uri" />
                </extension>
                <code value="http://hl7.org/fhirpath/System.String" />
            </type>
            <fixedUri value="http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter" />
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <short value="Value of extension" />
            <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list)." />
            <min value="1" />
            <max value="1" />
            <base>
                <path value="Extension.value[x]" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <xpath value="@value|f:*|h:div" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
        </element>
    </snapshot>
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="Associated Encounter" />
            <definition value="This encounter occurs within the scope of the referenced encounter." />
            <min value="0" />
            <max value="1" />
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <max value="0" />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <min value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "encounter-associatedEncounter",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 1
        }
    ],
    "url": "http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter",
    "version": "4.0.1",
    "name": "associatedEncounter",
    "title": "associatedEncounter",
    "status": "draft",
    "date": "2015-02-21",
    "publisher": "Health Level Seven, Inc. - FHIR WG",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "HL7"
                }
            ]
        }
    ],
    "description": "This encounter occurs within the scope of the referenced encounter.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        }
    ],
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "Encounter"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "snapshot": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "Associated Encounter",
                "definition": "This encounter occurs within the scope of the referenced encounter.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Extension",
                    "min": 0,
                    "max": "*"
                },
                "condition":  [
                    "ele-1"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "xpath": "@value|f:*|h:div",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Extension.id",
                "path": "Extension.id",
                "representation":  [
                    "xmlAttr"
                ],
                "short": "Unique id for inter-element referencing",
                "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Element.id",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                                "valueUrl": "string"
                            }
                        ],
                        "code": "http://hl7.org/fhirpath/System.String"
                    }
                ],
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    }
                ]
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "description": "Extensions are always sliced by (at least) url",
                    "rules": "open"
                },
                "short": "Extension",
                "definition": "An Extension",
                "min": 0,
                "max": "0",
                "base": {
                    "path": "Element.extension",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "Extension"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "xpath": "@value|f:*|h:div",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": false,
                "isSummary": false
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "representation":  [
                    "xmlAttr"
                ],
                "short": "identifies the meaning of the extension",
                "definition": "Source of the definition for the extension code - a logical name or a URL.",
                "comment": "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.",
                "min": 1,
                "max": "1",
                "base": {
                    "path": "Extension.url",
                    "min": 1,
                    "max": "1"
                },
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                                "valueUrl": "uri"
                            }
                        ],
                        "code": "http://hl7.org/fhirpath/System.String"
                    }
                ],
                "fixedUri": "http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter",
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "N/A"
                    }
                ]
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "short": "Value of extension",
                "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list).",
                "min": 1,
                "max": "1",
                "base": {
                    "path": "Extension.value[x]",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Encounter"
                        ]
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "xpath": "@value|f:*|h:div",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "N/A"
                    }
                ]
            }
        ]
    },
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "Associated Encounter",
                "definition": "This encounter occurs within the scope of the referenced encounter.",
                "min": 0,
                "max": "1"
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "max": "0"
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Encounter"
                        ]
                    }
                ]
            }
        ]
    }
}