Visit the HL7 website
Visit the FHIR website

CA Core+ 1.0.0 DFT-preBallot

1.0.0-DFT-preBallot   Canada flag
  • Home
  • Business Context
    • Business Context
    • Relationship to PCHDCF
    • Relationship to Other Specifications
    • CA Core+ to pCHDCF Mapping
  • Technical Context
    • Technical Context
    • Artifact Status Summary
    • Profiling Conventions & Approach
    • General Guidance
    • Mapping Logic
    • Security And Privacy
  • Modules
    • Modules
    • Common Data Exchange
    • Workflows
  • FHIR Artifacts
    • FHIR Artifacts
    • Profiles
    • Extensions
    • Data Types
    • Terminology
    • Examples
    • Download
  • Change Log
    • Change Log
    • Specification Guidance
    • Copyrights
    • Known Issues & Future Development
    • Specification Feedback
    1. Home
    2. FHIR Artifacts
    3. Extensions
    4. PatientPresentLocation

Draft preBallot - This specification is under preBallot review and subject to change. It should not be used for implementation purposes. . . . . For a full list of available versions, see the Directory of published versions

PatientPresentLocation

Links

Extension

CA-eReC-Patient-Present-Location-EXT

Description

Extension used to communicate the present location of the patient if it is different than the patient's home address.

References to this Extension

ServiceRequestCACore

Resource Content

  • Overview
  • Tree view
  • XML
  • JSON
PatientPresentLocation (Extension)IExtension
There are no (further) constraints on this element
Element id

Extension

Short description

Optional Extensions Element

Definition

Used to communicate the present location of the patient if it is different than the patient's home address.

Data type

Extension

Constraints
  • 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()
Mappings
  • rim: n/a
  • rim: N/A
id0..1string
There are no (further) constraints on this element
Element id

Extension.id

Short description

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.

Data type

string

Mappings
  • rim: n/a
extensionI0..0Extension
There are no (further) constraints on this element
Element id

Extension.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

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.

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.

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url
Constraints
  • 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()
Mappings
  • rim: n/a
url1..1uriFixed Value
There are no (further) constraints on this element
Element id

Extension.url

Short description

identifies the meaning of the extension

Definition

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

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.

Data type

uri

Fixed value

http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/CA-eReC-Patient-Present-Location-EXT

Mappings
  • rim: N/A
value[x]0..1
There are no (further) constraints on this element
Element id

Extension.value[x]

Short description

Value of extension

Definition

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
valueReferenceReference(LocationCACore)
There are no (further) constraints on this element
Data type

Reference(LocationCACore)

PatientPresentLocation (Extension)IExtensionElement id

Extension

Short description

Optional Extensions Element

Definition

Used to communicate the present location of the patient if it is different than the patient's home address.

Data type

Extension

Constraints
  • 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()
Mappings
  • rim: n/a
  • rim: N/A
id0..1string
There are no (further) constraints on this element
Element id

Extension.id

Short description

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.

Data type

string

Mappings
  • rim: n/a
extensionI0..0Extension
There are no (further) constraints on this element
Element id

Extension.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

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.

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.

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url
Constraints
  • 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()
Mappings
  • rim: n/a
url1..1uriFixed ValueElement id

Extension.url

Short description

identifies the meaning of the extension

Definition

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

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.

Data type

uri

Fixed value

http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/CA-eReC-Patient-Present-Location-EXT

Mappings
  • rim: N/A
value[x]0..1
There are no (further) constraints on this element
Element id

Extension.value[x]

Short description

Value of extension

Definition

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
valueReferenceReference(LocationCACore)Data type

Reference(LocationCACore)

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="CA-eReC-Patient-Present-Location-EXT" />
    <url value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/CA-eReC-Patient-Present-Location-EXT" />
    <name value="PatientPresentLocation" />
    <title value="PatientPresentLocation" />
    <status value="draft" />
    <description value="Extension used to communicate the present location of the patient if it is different than the patient&#39;s home address." />
    <fhirVersion value="4.0.1" />
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="ServiceRequest" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <snapshot>
        <element id="Extension">
            <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
                <valueCode value="normative" />
            </extension>
            <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
                <valueCode value="4.0.0" />
            </extension>
            <path value="Extension" />
            <short value="Optional Extensions Element" />
            <definition value="Used to communicate the present location of the patient if it is different than the patient&#39;s home address." />
            <min value="0" />
            <max value="*" />
            <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;)])" />
            </constraint>
            <isModifier value="false" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
        </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="Additional content defined by implementations" />
            <definition value="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." />
            <comment value="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." />
            <alias value="extensions" />
            <alias value="user content" />
            <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" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
        </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://fhir.infoway-inforoute.ca/cacore/StructureDefinition/CA-eReC-Patient-Present-Location-EXT" />
            <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](extensibility.html) for a list)." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Extension.value[x]" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/location-ca-core" />
            </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" />
            <definition value="Used to communicate the present location of the patient if it is different than the patient&#39;s home address." />
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <max value="0" />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/CA-eReC-Patient-Present-Location-EXT" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/location-ca-core" />
            </type>
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "CA-eReC-Patient-Present-Location-EXT",
    "url": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/CA-eReC-Patient-Present-Location-EXT",
    "name": "PatientPresentLocation",
    "title": "PatientPresentLocation",
    "status": "draft",
    "description": "Extension used to communicate the present location of the patient if it is different than the patient's home address.",
    "fhirVersion": "4.0.1",
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "ServiceRequest"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "snapshot": {
        "element":  [
            {
                "id": "Extension",
                "extension":  [
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
                        "valueCode": "normative"
                    },
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
                        "valueCode": "4.0.0"
                    }
                ],
                "path": "Extension",
                "short": "Optional Extensions Element",
                "definition": "Used to communicate the present location of the patient if it is different than the patient's home address.",
                "min": 0,
                "max": "*",
                "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')])"
                    }
                ],
                "isModifier": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    },
                    {
                        "identity": "rim",
                        "map": "N/A"
                    }
                ]
            },
            {
                "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": "Additional content defined by implementations",
                "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.",
                "comment": "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.",
                "alias":  [
                    "extensions",
                    "user content"
                ],
                "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,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    }
                ]
            },
            {
                "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://fhir.infoway-inforoute.ca/cacore/StructureDefinition/CA-eReC-Patient-Present-Location-EXT",
                "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](extensibility.html) for a list).",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Extension.value[x]",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/location-ca-core"
                        ]
                    }
                ],
                "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",
                "definition": "Used to communicate the present location of the patient if it is different than the patient's home address."
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "max": "0"
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/CA-eReC-Patient-Present-Location-EXT"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/location-ca-core"
                        ]
                    }
                ]
            }
        ]
    }
}

Terminology bindings

Table of Contents | IG © based on FHIR R4 | Package package:ca.infoway.io.core@1.0.0-dft-preballot | Version History
HL7® and FHIR® are the registered trademarks of Health Level Seven International