XIG: CapabilityStatement/VH-ClinicalDataRepository

FHIR IG Statistics: CapabilityStatement/VH-ClinicalDataRepository

Package	fhir.virtually.healthcare
Type	CapabilityStatement
Id	VH-ClinicalDataRepository
FHIR Version	R4
Source	https://fhir.virtually.healthcare/https://build.fhir.org/ig/Virtually-Healthcare/R4/CapabilityStatement-VH-ClinicalDataRepository.html
URL	https://fhir.virtually.healthcare/CapabilityStatement/VH-ClinicalDataRepository
Version	0.1.1-current
Status	draft
Date	2024-10-08
Name	ClinicalDataRepository
Title	Virtually Healthcare - Clinical Data Repository
Realm	us
Authority	hl7
Description	The 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)
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

StructureDefinition
AllergyIntolerance	AllergyIntolerance
Binary	Binary
DocumentReference	DocumentReference
Immunization	Immunization
MedicationRequest	MedicationRequest
Observation	Observation
Patient	Patient
UKCore-Patient	UK 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 Type	Profile	R	S	Searches
Patient	https://fhir.virtually.healthcare/StructureDefinition/Patient Additional supported profiles: UK Core Patient	y	y	_id, birthdate, family, gender, given, identifier, name
AllergyIntolerance	https://fhir.virtually.healthcare/StructureDefinition/AllergyIntolerance Additional supported profiles: UK Core Allergy Intolerance		y	patient, clinical-status, date, last-date
Condition	http://hl7.org/fhir/StructureDefinition/Condition Additional supported profiles: UK Core Condition		y	patient, onset-date
DocumentReference	https://fhir.virtually.healthcare/StructureDefinition/DocumentReference Additional supported profiles: UK Core Document Reference		y	patient, date
Immunization	https://fhir.virtually.healthcare/StructureDefinition/Immunization Additional supported profiles: UK Core Immunization		y	patient, date
MedicationRequest	https://fhir.virtually.healthcare/StructureDefinition/MedicationRequest Additional supported profiles: UK Core Medication Request		y	patient, authoredon
Observation	https://fhir.virtually.healthcare/StructureDefinition/Observation Additional supported profiles: UK Core Observation Vital Signs Profile		y	patient, date, category, code, status
Binary	https://fhir.virtually.healthcare/StructureDefinition/Binary	y

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`
SHALL	birthdate	`date`	A patients date of birth
SHALL	family	`string`	A patients surname
SHALL	gender	`token`	A patients gender - administrative
SHALL	given	`string`	A patients first name
SHALL	identifier	`token`	A patients NHS Number e.g. `identifier=https://fhir.nhs.uk/Id/nhs-number\|9876543210`
SHALL	name	`string`	A patients name

Combined Search Parameters

Conformance	Parameters	Types
	birthdate+family	`date`+`string`
	birthdate+name	`date`+`string`
	gender+family	`token`+`string`
	gender+name	`token`+`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

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	Who the sensitivity is for
SHALL	clinical-status	`token`	active \| inactive \| resolved
SHALL	date	`date`	Date first version of the resource instance was recorded
SHALL	last-date	`date`	Date(/time) of last known occurrence of a reaction

Combined Search Parameters

Conformance	Parameters	Types
	patient+clinical-status	`reference`+`token`
	patient+date	`reference`+`date`
	patient+last-date	`reference`+`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

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	Who has the condition?
SHALL	onset-date	`date`	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

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	Who/what is the subject of the document
SHALL	date	`date`	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

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	The patient for the vaccination record
SHALL	date	`date`	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

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	Returns prescriptions for a specific patient
SHALL	authoredon	`date`	Return prescriptions written on this date

Resource Conformance: SHALL Observation

Base System Profile
Observation

Profile Conformance
SHALL

Reference Policy

Supported Profiles

UK Core Observation
Vital Signs Profile

Interaction summary

Supports search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	The subject that the observation is about (if patient)
SHALL	date	`date`	Obtained date/time. If the obtained element is a period, a date that falls in the period
SHALL	category	`token`	The classification of the type of observation
SHALL	code	`token`	Obtained date/time. If the obtained element is a period, a date that falls in the period
SHALL	status	`token`	The status of the observation

Combined Search Parameters

Conformance	Parameters	Types
	patient+category	`reference`+`token`
	patient+code	`reference`+`token`
	patient+category+date	`reference`+`token`+`date`
	patient+category+status	`reference`+`token`+`token`
	patient+code+date	`reference`+`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"
            }
          ]
        }
      ]
    }
  ]
}

FHIR IG Statistics: CapabilityStatement/VH-ClinicalDataRepository

Resources that use this resource

Resources that this resource uses

Narrative

Virtually Healthcare - Clinical Data Repository

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL Patient

Resource Conformance: SHALL AllergyIntolerance

Resource Conformance: SHALL Condition

Resource Conformance: SHALL DocumentReference

Resource Conformance: SHALL Immunization

Resource Conformance: SHALL MedicationRequest

Resource Conformance: SHALL Observation

Resource Conformance: SHALL Binary

Source

Mode: `server`