ValueSet

ValueSet contains all currently available entries (codes and display values) of the selected catalog on the SAMPLES Server.

These codes shall be used in a ServiceRequest (creating an order).

Query

Endpoint

GET <serveraddress>/fhir/ValueSet

This returns a Bundle with all available ValueSets.

Parameter

Parameter Query example Description
id <endpoint>/<id> the technical id of the catalog

Following ids are available:

  • cellpopulations
  • clinicaltrials
  • diagnoses
  • goals
  • indications
  • medications
  • sampletypes
  • units

Examples

Cell populations

{
    "resourceType": "ValueSet",
    "status": "active",
    "name": "SAMPLES Server ValueSet for cell populations",
    "id": "cellpopulations",
    "description": "This ValueSet contains all currently available cell populations on the SAMPLES Server.",
    "url": "http://www.qualitype.de/samples/fhir/ValueSet/cellpopulations",
    "identifier":  [
        {
            "system": "http://www.qualitype.de/samples/fhir/NamingSystem/valueset-identifier",
            "value": "cellpopulations"
        }
    ],
    "publisher": "qualitype GmbH",
    "expansion": {
        "timestamp": "2023-07-01T12:00:00+00:00",
        "total": 2,
        "contains":  [
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/cellpopulations",
                "code": "CELLPOPULATION-1",
                "display": "Cellpopulation 1"
            },
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/cellpopulations",
                "code": "CELLPOPULATION-2",
                "display": "Cellpopulation 2"
            }
        ]
    }
}

Clinical trials

{
    "resourceType": "ValueSet",
    "status": "active",
    "name": "SAMPLES Server ValueSet for clinical trials",
    "id": "clinicaltrials",
    "description": "This ValueSet contains all currently available clinical trials on the SAMPLES Server.",
    "url": "http://www.qualitype.de/samples/fhir/ValueSet/clinicaltrials",
    "identifier":  [
        {
            "system": "http://www.qualitype.de/samples/fhir/NamingSystem/valueset-identifier",
            "value": "clinicaltrials"
        }
    ],
    "publisher": "qualitype GmbH",
    "expansion": {
        "timestamp": "2023-07-01T12:00:00+00:00",
        "total": 2,
        "contains":  [
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/clinicaltrials",
                "code": "CLINICALTRIAL-1",
                "display": "Clinical trial 1"
            },
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/clinicaltrials",
                "code": "CLINICALTRIAL-2",
                "display": "Clinical trial 2"
            }
        ]
    }
}

Diagnoses

{
    "resourceType": "ValueSet",
    "status": "active",
    "name": "SAMPLES Server ValueSet for diagnoses",
    "id": "diagnoses",
    "description": "This ValueSet contains all currently available diagnoses on the SAMPLES Server.",
    "url": "http://www.qualitype.de/samples/fhir/ValueSet/diagnoses",
    "identifier":  [
        {
            "system": "http://www.qualitype.de/samples/fhir/NamingSystem/valueset-identifier",
            "value": "diagnoses"
        }
    ],
    "publisher": "qualitype GmbH",
    "expansion": {
        "timestamp": "2023-07-01T12:00:00+00:00",
        "total": 2,
        "contains":  [
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/diagnoses",
                "code": "DIAGNOSIS-1",
                "display": "Diagnosis 1"
            },
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/diagnoses",
                "code": "DIAGNOSIS-2",
                "display": "Diagnosis 2"
            }
        ]
    }
}

Goals

{
    "resourceType": "ValueSet",
    "status": "active",
    "name": "SAMPLES Server ValueSet for goals",
    "id": "goals",
    "description": "This ValueSet contains all currently available goals on the SAMPLES Server.",
    "url": "http://www.qualitype.de/samples/fhir/ValueSet/goals",
    "identifier":  [
        {
            "system": "http://www.qualitype.de/samples/fhir/NamingSystem/valueset-identifier",
            "value": "goals"
        }
    ],
    "publisher": "qualitype GmbH",
    "expansion": {
        "timestamp": "2023-07-01T12:00:00+00:00",
        "total": 2,
        "contains":  [
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/goals",
                "code": "GOAL-1",
                "display": "Goal 1"
            },
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/goals",
                "code": "GOAL-2",
                "display": "Goal 2"
            }
        ]
    }
}

Indications

{
    "resourceType": "ValueSet",
    "status": "active",
    "name": "SAMPLES Server ValueSet for indications",
    "id": "indications",
    "description": "This ValueSet contains all currently available indications on the SAMPLES Server.",
    "url": "http://www.qualitype.de/samples/fhir/ValueSet/indications",
    "identifier":  [
        {
            "system": "http://www.qualitype.de/samples/fhir/NamingSystem/valueset-identifier",
            "value": "indications"
        }
    ],
    "publisher": "qualitype GmbH",
    "expansion": {
        "timestamp": "2023-07-01T12:00:00+00:00",
        "total": 2,
        "contains":  [
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/indications",
                "code": "INDICATION-1",
                "display": "Indication 1"
            },
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/indications",
                "code": "INDICATION-2",
                "display": "Indication 2"
            }
        ]
    }
}

Medications

{
    "resourceType": "ValueSet",
    "status": "active",
    "name": "SAMPLES Server ValueSet for medications",
    "id": "medications",
    "description": "This ValueSet contains all currently available medications on the SAMPLES Server.",
    "url": "http://www.qualitype.de/samples/fhir/ValueSet/medications",
    "identifier":  [
        {
            "system": "http://www.qualitype.de/samples/fhir/NamingSystem/valueset-identifier",
            "value": "medications"
        }
    ],
    "publisher": "qualitype GmbH",
    "expansion": {
        "timestamp": "2023-07-01T12:00:00+00:00",
        "total": 2,
        "contains":  [
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/medications",
                "code": "MEDICATION-1",
                "display": "Medication 1"
            },
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/medications",
                "code": "MEDICATION-2",
                "display": "Medication 2"
            }
        ]
    }
}

Sample types

{
    "resourceType": "ValueSet",
    "status": "active",
    "name": "SAMPLES Server ValueSet for sample types",
    "id": "sampletypes",
    "description": "This ValueSet contains all currently available sample types on the SAMPLES Server.",
    "url": "http://www.qualitype.de/samples/fhir/ValueSet/sampletypes",
    "identifier":  [
        {
            "system": "http://www.qualitype.de/samples/fhir/NamingSystem/valueset-identifier",
            "value": "sampletypes"
        }
    ],
    "publisher": "qualitype GmbH",
    "expansion": {
        "timestamp": "2023-07-01T12:00:00+00:00",
        "total": 2,
        "contains":  [
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/sampletypes",
                "code": "SAMPLETYPE-1",
                "display": "Sample type 1"
            },
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/sampletypes",
                "code": "SAMPLETYPE-2",
                "display": "Sample type 2"
            }
        ]
    }
}

Units

{
    "resourceType": "ValueSet",
    "status": "active",
    "name": "SAMPLES Server ValueSet for units",
    "id": "units",
    "description": "This ValueSet contains all currently available units on the SAMPLES Server.",
    "url": "http://www.qualitype.de/samples/fhir/ValueSet/units",
    "identifier":  [
        {
            "system": "http://www.qualitype.de/samples/fhir/NamingSystem/valueset-identifier",
            "value": "units"
        }
    ],
    "publisher": "qualitype GmbH",
    "expansion": {
        "timestamp": "2023-07-01T12:00:00+00:00",
        "total": 2,
        "contains":  [
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/units",
                "code": "mL",
                "display": "Milliliter"
            },
            {
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/units",
                "code": "mg",
                "display": "Milligramm"
            }
        ]
    }
}