GP Connect Data Model | FHIR STU3 Representation

Extension: Extension-CareConnect-GPC-ClinicalSetting-1

Extension	I		Extension	Element id Extension Short description To record the clinical setting of a problem list Definition To record the clinical setting of a problem list. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() \| (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
id		0..1	string	There are no (further) constraints on this element Element id Extension.id Short description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Comments Note that FHIR strings may not exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim: n/a
extension	I	0..*	Extension	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. In order 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 is allowed to 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() \| (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
url		1..1	uriFixed Value	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 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Fixed value https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ClinicalSetting-1 Mappings rim: n/a rim: N/A
valueCodeableConcept		1..1	CodeableConceptBinding	Element id Extension.valueCodeableConcept:valueCodeableConcept Short description The clinical setting of a list Definition The clinical setting of a list. Data type CodeableConcept Binding A code from the SNOMED Clinical Terminology UK coding system that describes a correspondence care setting type. Care Connect Care Setting Type (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim: n/a rim: N/A

Extension
Definition	To record the clinical setting of a problem list.
Cardinality	0...1
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() \| (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
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...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim: n/a
Extension.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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	ele-1: All FHIR elements must have a @value or children `hasValue() \| (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
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Fixed Value	https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ClinicalSetting-1
Mappings	rim: n/a rim: N/A
Extension.valueCodeableConcept:valueCodeableConcept
Definition	The clinical setting of a list.
Cardinality	1...1
Type	CodeableConcept
Binding	A code from the SNOMED Clinical Terminology UK coding system that describes a correspondence care setting type. Care Connect Care Setting Type (required)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim: n/a rim: N/A

<StructureDefinition xmlns="http://hl7.org/fhir">
    <meta>
        <lastUpdated value="2018-05-10T15:24:31.86+01:00" />
    </meta>
    <url value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ClinicalSetting-1" />
    <version value="1.0.0" />
    <name value="Extension-CareConnect-GPC-ClinicalSetting-1" />
    <status value="active" />
    <date value="2018-04-17T08:25:18.264+01:00" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="INTEROPen" />
        <telecom>
            <system value="email" />
            <value value="admin@interopen.org" />
            <use value="work" />
        </telecom>
    </contact>
    <description value="An extension to record the clinical setting of a problem list." />
    <purpose value="CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/" />
    <copyright value="Copyright &#169; 2016 HL7 UK\n\nLicensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n\nHL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7\n\nThe HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at\n\nhttps://www.hl7.org/fhir/license.html" />
    <fhirVersion value="3.0.1" />
    <kind value="complex-type" />
    <abstract value="false" />
    <contextType value="resource" />
    <context value="List" />
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <snapshot>
        <element id="Extension">
            <path value="Extension" />
            <short value="To record the clinical setting of a problem list" />
            <definition value="To record the clinical setting of a problem list." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Element" />
                <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() | (children().count() &gt; id.count())" />
                <xpath value="@value|f:*|h:div" />
            </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>
            <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="xml:id (or equivalent in JSON)" />
            <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
            <comment value="Note that FHIR strings may not exceed 1MB in size" />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Element.id" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="string" />
            </type>
            <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() | (children().count() &gt; id.count())" />
                <xpath value="@value|f:*|h:div" />
            </constraint>
            <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. In order 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 is allowed to 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="*" />
            <base>
                <path value="Element.extension" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="Extension" />
            </type>
            <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() | (children().count() &gt; id.count())" />
                <xpath value="@value|f:*|h:div" />
            </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>
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
            <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>
                <code value="uri" />
            </type>
            <fixedUri value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ClinicalSetting-1" />
            <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() | (children().count() &gt; id.count())" />
                <xpath value="@value|f:*|h:div" />
            </constraint>
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
        </element>
        <element id="Extension.valueCodeableConcept:valueCodeableConcept">
            <path value="Extension.valueCodeableConcept" />
            <sliceName value="valueCodeableConcept" />
            <short value="The clinical setting of a list" />
            <definition value="The clinical setting of a list." />
            <comment value="A stream of bytes, base64 encoded" />
            <min value="1" />
            <max value="1" />
            <base>
                <path value="Extension.value[x]" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="CodeableConcept" />
            </type>
            <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() | (children().count() &gt; id.count())" />
                <xpath value="@value|f:*|h:div" />
            </constraint>
            <binding>
                <strength value="required" />
                <description value="A code from the SNOMED Clinical Terminology UK coding system that describes a correspondence care setting type." />
                <valueSetReference>
                    <reference value="https://fhir.nhs.uk/STU3/ValueSet/CareConnect-CareSettingType-1" />
                </valueSetReference>
            </binding>
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
        </element>
    </snapshot>
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="To record the clinical setting of a problem list" />
            <definition value="To record the clinical setting of a problem list." />
            <max value="1" />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ClinicalSetting-1" />
        </element>
        <element id="Extension.valueCodeableConcept:valueCodeableConcept">
            <path value="Extension.valueCodeableConcept" />
            <sliceName value="valueCodeableConcept" />
            <short value="The clinical setting of a list" />
            <definition value="The clinical setting of a list." />
            <min value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
            <binding>
                <strength value="required" />
                <description value="A code from the SNOMED Clinical Terminology UK coding system that describes a correspondence care setting type." />
                <valueSetReference>
                    <reference value="https://fhir.nhs.uk/STU3/ValueSet/CareConnect-CareSettingType-1" />
                </valueSetReference>
            </binding>
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "meta": {
        "lastUpdated": "2018-05-10T15:24:31.86+01:00"
    },
    "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ClinicalSetting-1",
    "version": "1.0.0",
    "name": "Extension-CareConnect-GPC-ClinicalSetting-1",
    "status": "active",
    "date": "2018-04-17T08:25:18.264+01:00",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "INTEROPen",
            "telecom":  [
                {
                    "system": "email",
                    "value": "admin@interopen.org",
                    "use": "work"
                }
            ]
        }
    ],
    "description": "An extension to record the clinical setting of a problem list.",
    "purpose": "CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/",
    "copyright": "Copyright © 2016 HL7 UK\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n\nHL7® FHIR® standard Copyright © 2011+ HL7\n\nThe HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at\n\nhttps://www.hl7.org/fhir/license.html",
    "fhirVersion": "3.0.1",
    "kind": "complex-type",
    "abstract": false,
    "contextType": "resource",
    "context":  [
        "List"
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "snapshot": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "To record the clinical setting of a problem list",
                "definition": "To record the clinical setting of a problem list.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Element",
                    "min": 0,
                    "max": "*"
                },
                "condition":  [
                    "ele-1"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() | (children().count() > id.count())",
                        "xpath": "@value|f:*|h:div"
                    },
                    {
                        "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')])"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    },
                    {
                        "identity": "rim",
                        "map": "N/A"
                    }
                ]
            },
            {
                "id": "Extension.id",
                "path": "Extension.id",
                "representation":  [
                    "xmlAttr"
                ],
                "short": "xml:id (or equivalent in JSON)",
                "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
                "comment": "Note that FHIR strings may not exceed 1MB in size",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Element.id",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "condition":  [
                    "ele-1"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() | (children().count() > id.count())",
                        "xpath": "@value|f:*|h:div"
                    }
                ],
                "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. In order 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 is allowed to 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": "*",
                "base": {
                    "path": "Element.extension",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "Extension"
                    }
                ],
                "condition":  [
                    "ele-1"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() | (children().count() > id.count())",
                        "xpath": "@value|f:*|h:div"
                    },
                    {
                        "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')])"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    },
                    {
                        "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":  [
                    {
                        "code": "uri"
                    }
                ],
                "fixedUri": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ClinicalSetting-1",
                "condition":  [
                    "ele-1"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() | (children().count() > id.count())",
                        "xpath": "@value|f:*|h:div"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    },
                    {
                        "identity": "rim",
                        "map": "N/A"
                    }
                ]
            },
            {
                "id": "Extension.valueCodeableConcept:valueCodeableConcept",
                "path": "Extension.valueCodeableConcept",
                "sliceName": "valueCodeableConcept",
                "short": "The clinical setting of a list",
                "definition": "The clinical setting of a list.",
                "comment": "A stream of bytes, base64 encoded",
                "min": 1,
                "max": "1",
                "base": {
                    "path": "Extension.value[x]",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "condition":  [
                    "ele-1"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() | (children().count() > id.count())",
                        "xpath": "@value|f:*|h:div"
                    }
                ],
                "binding": {
                    "strength": "required",
                    "description": "A code from the SNOMED Clinical Terminology UK coding system that describes a correspondence care setting type.",
                    "valueSetReference": {
                        "reference": "https://fhir.nhs.uk/STU3/ValueSet/CareConnect-CareSettingType-1"
                    }
                },
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    },
                    {
                        "identity": "rim",
                        "map": "N/A"
                    }
                ]
            }
        ]
    },
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "To record the clinical setting of a problem list",
                "definition": "To record the clinical setting of a problem list.",
                "max": "1"
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ClinicalSetting-1"
            },
            {
                "id": "Extension.valueCodeableConcept:valueCodeableConcept",
                "path": "Extension.valueCodeableConcept",
                "sliceName": "valueCodeableConcept",
                "short": "The clinical setting of a list",
                "definition": "The clinical setting of a list.",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "binding": {
                    "strength": "required",
                    "description": "A code from the SNOMED Clinical Terminology UK coding system that describes a correspondence care setting type.",
                    "valueSetReference": {
                        "reference": "https://fhir.nhs.uk/STU3/ValueSet/CareConnect-CareSettingType-1"
                    }
                }
            }
        ]
    }
}