FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/VH-ClinicalDataRepository

Packagefhir.virtually.healthcare
TypeCapabilityStatement
IdVH-ClinicalDataRepository
FHIR VersionR4
Sourcehttps://fhir.virtually.healthcare/https://build.fhir.org/ig/Virtually-Healthcare/R4/CapabilityStatement-VH-ClinicalDataRepository.html
URLhttps://fhir.virtually.healthcare/CapabilityStatement/VH-ClinicalDataRepository
Version0.1.1-current
Statusdraft
Date2024-10-08
NameClinicalDataRepository
TitleVirtually Healthcare - Clinical Data Repository
Realmus
Authorityhl7
DescriptionThe CDR adheres to the following standards: - [UK SNOMED CT](https://digital.nhs.uk/services/terminology-and-classifications/snomed-ct) and [LOINC](https://loinc.org/) for our clinical terminology. - [NHS Data Dictionary](https://www.datadictionary.nhs.uk/) for identifiers and values, such as NHS Number, GMC, GMP, ODS, etc. - [HL7 UK Core](https://simplifier.net/HL7FHIRUKCoreR4/) The CDR closely follows: - [HL7 International Patient Access](https://build.fhir.org/ig/HL7/fhir-ipa/) Server - [IHE Query for Existing Data for Mobile (QEDm)](https://build.fhir.org/ig/IHE/QEDm/branches/master/index.html) Server - [HL7 UK - UK Core Access](https://build.fhir.org/ig/HL7-UK/UK-Core-Access/index.html)
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
AllergyIntoleranceAllergyIntolerance
BinaryBinary
DocumentReferenceDocumentReference
ImmunizationImmunization
MedicationRequestMedicationRequest
ObservationObservation
PatientPatient
UKCore-PatientUK Core Patient

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement VH-ClinicalDataRepository

Virtually Healthcare - Clinical Data Repository

  • Implementation Guide Version: 0.1.1-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2024-10-08
  • Published by: Virtually Healthcare

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)

Resource Conformance: SHALL Patient

Base System Profile
Patient
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Patient

Interaction summary
  • SHALL support search-type.
  • Supports read.

Documentation
GET /Patient?{parameters}

Conformance to this implementation guide SHOULD be tested via FHIR Validation.

Search Examples

Search for Patient's for a patient with a NHS Number of 9876543210

GET /Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210
``
Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLbirthdatedate

A patients date of birth

SHALLfamilystring

A patients surname

SHALLgendertoken

A patients gender - administrative

SHALLgivenstring

A patients first name

SHALLidentifiertoken

A patients NHS Number e.g. identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210

SHALLnamestring

A patients name

Combined Search Parameters
ConformanceParametersTypes
 birthdate+familydate+string
 birthdate+namedate+string
 gender+familytoken+string
 gender+nametoken+string

Resource Conformance: SHALL AllergyIntolerance

Base System Profile
AllergyIntolerance
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Allergy Intolerance

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who the sensitivity is for

SHALLclinical-statustoken

active | inactive | resolved

SHALLdatedate

Date first version of the resource instance was recorded

SHALLlast-datedate

Date(/time) of last known occurrence of a reaction

Combined Search Parameters
ConformanceParametersTypes
 patient+clinical-statusreference+token
 patient+datereference+date
 patient+last-datereference+date

Resource Conformance: SHALL Condition

Base System Profile
Condition
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Condition

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who has the condition?

SHALLonset-datedate

Date related onsets (dateTime and Period)

 

Resource Conformance: SHALL DocumentReference

Base System Profile
DocumentReference
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Document Reference

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who/what is the subject of the document

SHALLdatedate

When this document reference was created

 

Resource Conformance: SHALL Immunization

Base System Profile
Immunization
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Immunization

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The patient for the vaccination record

SHALLdatedate

Vaccination (non)-Administration Date

 

Resource Conformance: SHALL MedicationRequest

Base System Profile
MedicationRequest
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Medication Request

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Returns prescriptions for a specific patient

SHALLauthoredondate

Return prescriptions written on this date

 

Resource Conformance: SHALL Observation

Base System Profile
Observation
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The subject that the observation is about (if patient)

SHALLdatedate

Obtained date/time. If the obtained element is a period, a date that falls in the period

SHALLcategorytoken

The classification of the type of observation

SHALLcodetoken

Obtained date/time. If the obtained element is a period, a date that falls in the period

SHALLstatustoken

The status of the observation

Combined Search Parameters
ConformanceParametersTypes
 patient+categoryreference+token
 patient+codereference+token
 patient+category+datereference+token+date
 patient+category+statusreference+token+token
 patient+code+datereference+token+date

Resource Conformance: SHALL Binary

Base System Profile
Binary
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.


Source

{
  "resourceType": "CapabilityStatement",
  "id": "VH-ClinicalDataRepository",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://fhir.virtually.healthcare/CapabilityStatement/VH-ClinicalDataRepository",
  "version": "0.1.1-current",
  "name": "ClinicalDataRepository",
  "title": "Virtually Healthcare - Clinical Data Repository",
  "status": "draft",
  "experimental": false,
  "date": "2024-10-08",
  "publisher": "Virtually Healthcare",
  "contact": [
    {
      "name": "Virtually Healthcare",
      "telecom": [
        {
          "system": "url",
          "value": "https://virtually.healthcare"
        }
      ]
    }
  ],
  "description": "The CDR adheres to the following standards:\n\n - [UK SNOMED CT](https://digital.nhs.uk/services/terminology-and-classifications/snomed-ct) and [LOINC](https://loinc.org/) for our clinical terminology.\n - [NHS Data Dictionary](https://www.datadictionary.nhs.uk/) for identifiers and values, such as NHS Number, GMC, GMP, ODS, etc.\n - [HL7 UK Core](https://simplifier.net/HL7FHIRUKCoreR4/)\n\nThe CDR closely follows:\n\n - [HL7 International Patient Access](https://build.fhir.org/ig/HL7/fhir-ipa/) Server\n - [IHE Query for Existing Data for Mobile (QEDm)](https://build.fhir.org/ig/IHE/QEDm/branches/master/index.html) Server\n - [HL7 UK - UK Core Access](https://build.fhir.org/ig/HL7-UK/UK-Core-Access/index.html)",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "GB",
          "display": "United Kingdom of Great Britain and Northern Ireland"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            },
            {
              "extension": [
                {
                  "url": "required",
                  "valueString": "birthdate"
                },
                {
                  "url": "required",
                  "valueString": "family"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "required",
                  "valueString": "birthdate"
                },
                {
                  "url": "required",
                  "valueString": "name"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "required",
                  "valueString": "gender"
                },
                {
                  "url": "required",
                  "valueString": "family"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "required",
                  "valueString": "gender"
                },
                {
                  "url": "required",
                  "valueString": "name"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type": "Patient",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/Patient",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
          ],
          "documentation": "\n```\nGET /Patient?{parameters}\n```\n\nConformance to this implementation guide **SHOULD** be tested via [FHIR Validation](https://hl7.org/fhir/R4/validation.html).\n\n**Search Examples**\n\nSearch for Patient's for a patient with a NHS Number of 9876543210\n\n```\nGET /Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210\n``\n",
          "interaction": [
            {
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_id",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "birthdate",
              "type": "date",
              "documentation": "A patients date of birth"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "family",
              "type": "string",
              "documentation": "A patients surname"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "gender",
              "type": "token",
              "documentation": "A patients gender - administrative"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "given",
              "type": "string",
              "documentation": "A patients first name"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "type": "token",
              "documentation": "A patients NHS Number e.g. `identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210`"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "type": "string",
              "documentation": "A patients name"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            },
            {
              "extension": [
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "clinical-status"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "date"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "last-date"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type": "AllergyIntolerance",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/AllergyIntolerance",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "Who the sensitivity is for"
            },
            {
              "name": "clinical-status",
              "type": "token",
              "documentation": "active | inactive | resolved"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "date",
              "type": "date",
              "documentation": "Date first version of the resource instance was recorded"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "last-date",
              "type": "date",
              "documentation": "Date(/time) of last known occurrence of a reaction"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Condition",
          "profile": "http://hl7.org/fhir/StructureDefinition/Condition",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "Who has the condition?"
            },
            {
              "name": "onset-date",
              "type": "date",
              "documentation": "Date related onsets (dateTime and Period)"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "DocumentReference",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/DocumentReference",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "Who/what is the subject of the document"
            },
            {
              "name": "date",
              "type": "date",
              "documentation": "When this document reference was created"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Immunization",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/Immunization",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "The patient for the vaccination record"
            },
            {
              "name": "date",
              "type": "date",
              "documentation": "Vaccination (non)-Administration Date"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "MedicationRequest",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/MedicationRequest",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "Returns prescriptions for a specific patient"
            },
            {
              "name": "authoredon",
              "type": "date",
              "documentation": "Return prescriptions written on this date"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            },
            {
              "extension": [
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "category"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "code"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "category"
                },
                {
                  "url": "required",
                  "valueString": "date"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "category"
                },
                {
                  "url": "required",
                  "valueString": "status"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "code"
                },
                {
                  "url": "required",
                  "valueString": "date"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type": "Observation",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/Observation",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation",
            "http://hl7.org/fhir/StructureDefinition/vitalsigns"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "The subject that the observation is about (if patient)"
            },
            {
              "name": "date",
              "type": "date",
              "documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period"
            },
            {
              "name": "category",
              "type": "token",
              "documentation": "The classification of the type of observation"
            },
            {
              "name": "code",
              "type": "token",
              "documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period"
            },
            {
              "name": "status",
              "type": "token",
              "documentation": "The status of the observation"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Binary",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/Binary",
          "interaction": [
            {
              "code": "read"
            }
          ]
        }
      ]
    }
  ]
}