Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/Virtually-Healthcare-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir.virtually.healthcare/CapabilityStatement/VH-ClinicalDataRepository | Version: 0.1.0-current | |||
| Draft as of 2024-10-08 | Computable Name: ClinicalDataRepository | |||
The CDR adheres to the following standards:
The CDR closely follows:
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement VH-ClinicalDataRepository
application/fhir+xml, application/fhir+jsonNote 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.
serverThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Patient | https://fhir.virtually.healthcare/StructureDefinition/Patient Additional supported profiles: UK Core Patient http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient | y | y | _id, birthdate, family, gender, given, identifier, name, birthdate+family, birthdate+name, gender+family, gender+name | |||||
| AllergyIntolerance | https://fhir.virtually.healthcare/StructureDefinition/AllergyIntolerance Additional supported profiles: UK Core AllergyIntolerance http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance | y | patient, clinical-status, date, last-date, patient+clinical-status, patient+date, patient+last-date | ||||||
| Condition | https://fhir.virtually.healthcare/StructureDefinition/Condition Additional supported profiles: UK Core Condition | y | patient, onset-date | ||||||
| DocumentReference | https://fhir.virtually.healthcare/StructureDefinition/DocumentReference Additional supported profiles: https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference | 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 MedicationRequest | y | patient, authoredon | ||||||
| Observation | https://fhir.virtually.healthcare/StructureDefinition/Observation Additional supported profiles: UK Core Observation http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observationVital Signs Profile | y | patient, date, category, code, status, patient+category, patient+code, patient+category+date, patient+category+status, patient+code+date | ||||||
| Binary | http://hl7.org/fhir/StructureDefinition/Binary | y |
UK Core Patienthttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient
search-type.read.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 ``
| 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. |
| SHALL | name | string | A patients name |
| Conformance | Parameters | Types |
|---|---|---|
| SHALL | birthdate+family | date+string |
| SHALL | birthdate+name | date+string |
| SHALL | gender+family | token+string |
| SHALL | gender+name | token+string |
UK Core AllergyIntolerancehttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance
search-type.| 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 |
| Conformance | Parameters | Types |
|---|---|---|
| SHALL | patient+clinical-status | reference+token |
| SHALL | patient+date | reference+date |
| SHALL | patient+last-date | reference+date |
search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Who has the condition? |
| SHALL | onset-date | date | Date related onsets (dateTime and Period) |
https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference
search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Who/what is the subject of the document |
| SHALL | date | date | When this document reference was created |
search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The patient for the vaccination record |
| SHALL | date | date | Vaccination (non)-Administration Date |
search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Returns prescriptions for a specific patient |
| SHALL | authoredon | date | Return prescriptions written on this date |
UK Core Observationhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation
Vital Signs Profile
search-type.| 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 |
| Conformance | Parameters | Types |
|---|---|---|
| SHALL | patient+category | reference+token |
| SHALL | patient+code | reference+token |
| SHALL | patient+category+date | reference+token+date |
| SHALL | patient+category+status | reference+token+token |
| SHALL | patient+code+date | reference+token+date |
read.