StructureDefinition Extension-UKCore-SampleState

Context of Use Specimen

Tree View

url1..1System.StringFixed Value
codingΣ0..*CodingBinding
textΣ0..1string

Table View

Extension..
Extension.url..
Extension.value[x]CodeableConcept1..
Extension.value[x].coding..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-SampleCategory" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory" />
    <version value="1.0.0" />
    <name value="ExtensionUKCoreSampleCategory" />
    <title value="Extension UK Core Sample Category" />
    <status value="active" />
    <date value="2023-04-28" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="An extension to record the category of genome sequencing sample." />
    <purpose value="This extension is a Genomics use case to categorise the genome sequencing sample type, whether it is a tumour or germline Sample. This is different to Specimen.type which, for genomics, records the tissue of origin." />
    <fhirVersion value="4.0.1" />
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="Specimen" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="An extension to record the category of the sample." />
            <definition value="This extension allows the recording of the category of a sample for use within Genomics, whether it is a tumour or germline sample." />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <short value="A set of codes to record the category of the sample" />
            <min value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
        </element>
        <element id="Extension.value[x].coding">
            <path value="Extension.value[x].coding" />
            <binding>
                <strength value="preferred" />
                <description value="A set of codes to record the category of the sample" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-SampleCategory" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-SampleCategory",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory",
    "version": "1.0.0",
    "name": "ExtensionUKCoreSampleCategory",
    "title": "Extension UK Core Sample Category",
    "status": "active",
    "date": "2023-04-28",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "An extension to record the category of genome sequencing sample.",
    "purpose": "This extension is a Genomics use case to categorise the genome sequencing sample type, whether it is a tumour or germline Sample. This is different to Specimen.type which, for genomics, records the tissue of origin.",
    "fhirVersion": "4.0.1",
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "Specimen"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "An extension to record the category of the sample.",
                "definition": "This extension allows the recording of the category of a sample for use within Genomics, whether it is a tumour or germline sample."
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "short": "A set of codes to record the category of the sample",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ]
            },
            {
                "id": "Extension.value[x].coding",
                "path": "Extension.value[x].coding",
                "binding": {
                    "strength": "preferred",
                    "description": "A set of codes to record the category of the sample",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-SampleCategory"
                }
            }
        ]
    }
}

Examples

Sample Category- An example to illustrate the extension to show the Genomics classification of a sample.
Example UKCore-Specimen-Extension-SampleCategory

Guidance

There is a binding within this extension to a ValueSet UKCore-SampleCategory.


back to top