GP Connect Data Model | FHIR STU3 Representation

This version is in draft and is currently being migrated from the GP Connect Access Record: Structured specification

Extension: Extension-CareConnect-GPC-MedicationOrderStatement-1

id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueReference0..1Reference(CareConnect-GPC-MedicationStatement-1)
Extension
DefinitionMedication Statement link.
Cardinality0...*
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
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
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
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, 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
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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-MedicationOrderStatement-1

Mappings
  • rim: n/a
  • rim: N/A
Extension.value[x]:valueReference
DefinitionMedication Statement link.
Cardinality0...1
TypeReference(CareConnect-GPC-MedicationStatement-1)
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="2017-10-13T13:00:56.756+01:00" />
    </meta>
    <url value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationOrderStatement-1" />
    <version value="1.0.0" />
    <name value="Extension-CareConnect-GPC-MedicationOrderStatement-1" />
    <status value="draft" />
    <date value="2017-10-13T12:18:35.453+01:00" />
    <publisher value="HL7 UK" />
    <description value="Used to specify a link to the medication authorisation that this order is part of." />
    <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="MedicationRequest" />
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <snapshot>
        <element id="Extension">
            <path value="Extension" />
            <short value="Medication Statement link" />
            <definition value="Medication Statement link." />
            <min value="0" />
            <max value="*" />
            <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-MedicationOrderStatement-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.value[x]:valueReference">
            <path value="Extension.valueReference" />
            <sliceName value="valueReference" />
            <short value="Medication Statement link" />
            <definition value="Medication Statement link." />
            <comment value="A stream of bytes, base64 encoded" />
            <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="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-MedicationStatement-1" />
            </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>
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
        </element>
    </snapshot>
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="Medication Statement link" />
            <definition value="Medication Statement link." />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationOrderStatement-1" />
        </element>
        <element id="Extension.value[x]:valueReference">
            <path value="Extension.valueReference" />
            <sliceName value="valueReference" />
            <short value="Medication Statement link" />
            <definition value="Medication Statement link." />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-MedicationStatement-1" />
            </type>
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "meta": {
        "lastUpdated": "2017-10-13T13:00:56.756+01:00"
    },
    "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationOrderStatement-1",
    "version": "1.0.0",
    "name": "Extension-CareConnect-GPC-MedicationOrderStatement-1",
    "status": "draft",
    "date": "2017-10-13T12:18:35.453+01:00",
    "publisher": "HL7 UK",
    "description": "Used to specify a link to the medication authorisation that this order is part of.",
    "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":  [
        "MedicationRequest"
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "snapshot": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "Medication Statement link",
                "definition": "Medication Statement link.",
                "min": 0,
                "max": "*",
                "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-MedicationOrderStatement-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.value[x]:valueReference",
                "path": "Extension.valueReference",
                "sliceName": "valueReference",
                "short": "Medication Statement link",
                "definition": "Medication Statement link.",
                "comment": "A stream of bytes, base64 encoded",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Extension.value[x]",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-MedicationStatement-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"
                    }
                ]
            }
        ]
    },
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "Medication Statement link",
                "definition": "Medication Statement link."
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationOrderStatement-1"
            },
            {
                "id": "Extension.value[x]:valueReference",
                "path": "Extension.valueReference",
                "sliceName": "valueReference",
                "short": "Medication Statement link",
                "definition": "Medication Statement link.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-MedicationStatement-1"
                    }
                ]
            }
        ]
    }
}


back to top