API Hub

Explore and Make use of Nationally Defined Messaging APIs

This is a HL7 FHIR server, and as you appear to be accessing this page from a web browser you are seeing a HTML version of the requested resource(s). You can also access this URL from a FHIR client as a ReSTful API call. For more details please see the HL7 FHIR specification.
<?xml version="1.0" encoding="UTF-8" standalone="no"?><StructureDefinition xmlns="http://hl7.org/fhir">
   <id value="Extension-NDOP-NICReference-1"/>
   <meta>
      <lastUpdated value="2018-01-25T10:46:02.467+00:00"/>
   </meta>
   <url value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-NDOP-NICReference-1"/>
   <version value="1.0.0"/>
   <name value="Extension-NDOP-NICReference-1"/>
   <title value="Extension-NDOP-NICRef-1"/>
   <status value="draft"/>
   <date value="2018-01-24T09:49:08.175+00:00"/>
   <publisher value="NHS Digital"/>
   <description value="National Information Centre record reference allocated via their contact centre."/>
   <purpose value="To capture a National Information Centre record reference which may be used to trace the consent resource back to the NIC encounter with a patient or patient proxy."/>
   <copyright value="Copyright © 2017 NHS Digital"/>
   <fhirVersion value="3.0.1"/>
   <kind value="complex-type"/>
   <abstract value="false"/>
   <contextType value="resource"/>
   <context value="Consent"/>
   <type value="Extension"/>
   <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/>
   <derivation value="constraint"/>
   <snapshot>
      <element id="Extension">
         <path value="Extension"/>
         <short value="National Information Centre (NIC) Reference"/>
         <definition value="National Information Centre (NIC) Reference"/>
         <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() > 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(.), 'value')])"/>
         </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() > 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() > 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(.), 'value')])"/>
         </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-NDOP-NICReference-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() > 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]:NICReference">
         <path value="Extension.valueString"/>
         <sliceName value="valueString"/>
         <short value="National Information Centre (NIC) record reference"/>
         <definition value="National Information Centre record reference allocated when the NIC helpdesk is contacted to set a Opt-out Preference."/>
         <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="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() > 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="National Information Centre (NIC) Reference"/>
         <definition value="National Information Centre (NIC) Reference"/>
         <max value="1"/>
      </element>
      <element id="Extension.url">
         <path value="Extension.url"/>
         <fixedUri value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-NDOP-NICReference-1"/>
      </element>
      <element id="Extension.value[x]:NICReference">
         <path value="Extension.valueString"/>
         <sliceName value="valueString"/>
         <short value="National Information Centre (NIC) record reference"/>
         <definition value="National Information Centre record reference allocated when the NIC helpdesk is contacted to set a Opt-out Preference."/>
         <min value="1"/>
         <type>
            <code value="string"/>
         </type>
      </element>
   </differential>
</StructureDefinition>