Virtually Healthcare - IHE Patient Care Coordination (PCC)
0.1.1-current - ci-build
Virtually Healthcare - IHE Patient Care Coordination (PCC)
0.1.1-current - ci-build
Virtually Healthcare - IHE Patient Care Coordination (PCC) - Local Development build (v0.1.1-current) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the types of individuals and/or systems that will interact as part of the use cases covered by this implementation guide.
| CareDirectory Service |
Provides lookup or query services for master Organisation, Facility, Location, Practitioner, Healthcare Service, OrganisationAffiliation, and Endpoint records which meet specific criteria. |
| Clinical Data Consumer |
The Clinical Data Consumer sends FHIR-based queries to the Clinical Data Repository which exposes data in a clinical data repository |
| Clinical Data Repository |
The Clinical Data Repository is responsible for the persistent storage of clinical data items (observations, conditions, immunisations, etc). E.g. PHR, EHR and EPR Links to detailed elaboration on this actor can be found in:
|
| Event Consumer |
The Event Consumer Actor receives events. |
| Event Service |
The Event Service is an Event Messaging Endpoint for Trust Integration Engine (TIE) or similar Messaging Systems. |
| Event Source |
The Event Source Actor produces events based event triggers which occur during clinical activity (e.g. patient discharged). |
| Form Filler |
The Form Filler is responsible for completing the forms. |
| Form Manager |
Provides pre-population and data extraction services |
| Form Registry |
Repository for form definitions. Links to detailed elaboration on this actor can be found in:
|
| Intermediary |
This is a Trust Integration Engine (TIE) or Enterprise Service Bus (ESB) working at a community level |
| Referral Initiator |
Creates the Referral. The Referral Initiator Actor is implemented by the systems used by the clinical practice. |
| Referral Recipient |
Fulfils the Referral. The Referral Recipient Actor is implemented by clinical providers. |
| Service Facade |
This is a facade service. This acts as an Anti-Corruption-Layer which transforms data models in external services to an enterprise canonical data model/domain model. |
| Terminology Repository |
Central repository of codesystems (e.g. UK SNOMED CT), valuesets and concept maps. Links to detailed elaboration on this actor can be found in:
|
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
| Facade - IM1 Patient EMIS |
This is a Service Facade to IM1 Patient This is influenced by HL7 International Patient Access This is not a complete description of the API and so does not represent the actual implemented API or capabilities of the GP provider. This is a facade to the GP System IM1, this is not the API provided by the GP System. |
| Facade - IM1 Transaction EMIS |
This is a Service Facade to IM1 Transaction This is not a complete description of the API and so does not represent the actual implemented API or capabilities of the GP provider. This is a facade to the GP System IM1, this is not the API provided by the GP System. |
| Facade - IM1 Transaction TPP |
This is a Service Facade to IM1 Transaction This is not a complete description of the API and so does not represent the actual implemented API or capabilities of the GP provider. This is a facade to the GP System IM1, this is not the API provided by the GP System. |
| NHS England Directory Service Facade |
This is a Service Facade to Personal Demographics Service - FHIR API and Organisation Data Service - FHIR API This facade is related to IHE Patient Demographics Query for Mobile (PDQm) and IHE Mobile Care Services Discovery (mCSD) |
| Virtually Healthcare - Clinical Data Repository |
The CDR adheres to the following standards:
The CDR closely follows: |
These define the types of messages that can be sent and/or received by systems conforming to this implementation guide.
| Message Definition - Consultation Note |
DRAFT conversion of HL7 v2.4 ADT_A04 |
| Message Definition - Discharged |
DRAFT conversion of HL7 v2.4 ADT_A03 |
| Message Definition - Original Document Notification and Content |
DRAFT conversion of HL7 v2.5.1 MDM_T02 |
| Message Definition - Patient Referral |
DRAFT conversion of HL7 v2.5.1 REF_I12 - Patient referral |
| Message Definition - Unsolicited Observation |
DRAFT conversion of HL7 v2.5.1 ORU_R01 |
These define forms used by systems conforming to this implementation guide to capture or expose data to end users.
| Consultation Note |
Consultation Note |
| Daily Physical Activity |
Daily Physical Activity based on time based measures from HL7 Physical Activity Implementation Guide |
| Exercise Activity |
Exercise Activity based on activity based measures from HL7 Physical Activity Implementation Guide |
| PDS Patient Preferences |
PDS Patient Preferences - refactor of none demographics extensions in PDS Patient API |
| Patient Communication |
Patient Communication |
| Patient Referral Form (Domain Archetype) |
INITIAL VERSION Based on a combination of eRS and BARS requirements plus selected elements from North West GMSA |
| PharmacyNomination |
Pharmacy Nomination |
| Smoking Status |
Smoking Status based on PRSB Community Pharmacy Standard |
| Vital Signs |
Vital Signs Definitions based on PRSB Community Pharmacy Standard and NHS England Clinical Observations |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| AllergyIntolerance |
Extension to HL7 IPA AllergyIntolerance and includes elements from UKCore AllergyIntolerance |
| Binary |
TODO |
| CarePlan |
TODO in discovery |
| CareTeam |
TODO in discovery |
| ClinicalImpression |
TODO in discovery also known as Clinical Assessment |
| ConsulationNote |
Basic outline of a Consulation Note for use with GP Connect Send Document |
| DetectedIssue |
TODO in discovery |
| Device | |
| DiagnosticReport |
Extension of UKCore-UKCore-DiagnosticReport, to include Royal College of Radiologists (HL7 v2 ORU), Digital Health and Care Wales HL7 v2 ORU and HL7 IPS DiagnosticReport |
| DocumentReference |
Based on UK Definitions from IHE Europe Metadata for exchange medical documents and images |
| Encounter |
Merge of NHS England HL7 v2 ADT and UKCore-Encounter |
| Goal |
TODO in discovery |
| HealthcareService |
TODO in discovery |
| Immunization |
Extension to HL7 IPA Immunization plus requirements from UKCore Immunization |
| MedicationRequest |
HL7 IPA MedicationRequest plus requirements from UKCore-MedicationRequest |
| Observation |
Extension of HL7 IPA Observation to include elements of UKCore-Observation |
| Observation Panel |
DRAFT For use with Order Entry Forms |
| Organization |
Extension of UKCore Organization and includes elements from IHE Mobile Care Services Discovery (mCSD) |
| Patient |
Extension of UKCore-Patient and includes elements from HL7 International Access |
| PatientSummary |
Merge of PRSB Section Headers, NHS England Transfer of Care - Outpatient Letter and HL7 International Patient Summary Not following UKCore-Composition due to coding issues around section.code. |
| Practitioner |
Extension of UKCore Practitioner and includes elements from IHE Mobile Care Services Discovery (mCSD) |
| PractitionerRole |
DRAFT Extension of UKCore PractitionerRole |
| Procedure |
Extension to UKCore Procedure with requirements from HL7 IPA Condition |
| Questionnaire |
Based on HL7 Structured Data Capture |
| QuestionnaireResponse |
Based on HL7 Structured Data Capture |
| RelatedPerson |
Extension of UKCore-RelatedPerson |
| ServiceRequest |
Extension of UKCore-ServiceRequest plus requirements present in NHS England - e-Referral Service - FHIR API and and NHS England - Booking and Referral Standard |
| Task |
Based on FHIR Workflow |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Accession Number |
Usually assigned by the order filler. |
| Attachment |
DRAFT: Additional conformance on FHIR Attachment data type. In HL7 FHIR this is likely to be a Binary resource and in HL7 v2 the OBX segment. When laboratory reports include a url link in DiagnosticReport, the FHIR Bundle should also include a FHIR DocumentReference providing additional document metadata. |
| CodeableReference |
Backport of FHIR R5 CodeableReference. (copied from BE eHealth Platform Federal Core Profiles). Extension able to hold a reference and a concept (Temporary solution until https://jira.hl7.org/browse/FHIR-44661 is solved and see Zulip: https://chat.fhir.org/#narrow/stream/179280-fhir.2Finfrastructure-wg/topic/Backporting.20CodeableReference) |
| Correlation Identifier |
See Enterprise Integration Patterns - Correlation Identifier and Rule 3: Reference Other Aggregates by Identity (Implementing Domain Driven Design) |
| England Practitioner Identifier |
NHS Data Dictionary CONSULTANT CODE and GENERAL MEDICAL PRACTITIONER PPD CODE. |
| England Service Identifier |
See eRS - Search for healthcare services (A035, FHIR R4) and for BARS - Directory of Services (DoS) |
| Filler Order Number |
HL7 v2 Filler Order Number (ORC-3) |
| Identifier |
See also Enterprise Integration Patterns - Correlation Identifier and Rule 3: Reference Other Aggregates by Identity (Implementing Domain Driven Design) |
| Medical Record Number |
Only use in References Data Type if the NHS Number is not known or unverified. |
| NHS, HCSN and CHI Numbers |
NHS Data Dictionary: NHS NUMBER, COMMUNITY HEALTH INDEX NUMBER and HEALTH AND CARE NUMBER |
| Organisation Code |
NHS Data Dictionary ORGANISATION_CODE |
| Organisation Site Code |
NHS Data Dictionary ORGANISATION SITE IDENTIFIER Use ODS Site code relevant for organisation. E.g. Use Mid Yorkshire Hospitals NHS Trust (RXF) version of Pinderfields Hospital (RXF05) when referring to Mid Yorks, not others in the director |
| OriginatingReferralIdentifier |
Known as Originating Referral Identifier (HL7 v2 RF1-6) |
| Reference - RESTful |
A Reference data type where the referenced resource is expected to be resolvable RESTfully. |
| Reference - RESTful or Logical |
A Reference data type where the referenced resource could be resolvable RESTfully or pointed to logically. |
| SDS User Profile Id |
In NHS Englands Spine Directory Service this is the uniqueIdentifier in the nhsOrgPerson and nhsOrgPersonRole object (confirm this is true). This MISSING formal definition of this type HL7 v3/OID: 1.2.826.0.1285.0.2.0.67 |
| Staff Enterprise Number |
England Practitioner Identifier should take precedence over staff numbers (i.e. SDS User Id) in HL7 FHIR Reference and other interoperability standards. E.g. SDS User ID and Ministry of Defence Doctor. |
| Unique Booking Reference Number |
Unique Booking Reference Number. See also PATIENT PATHWAY IDENTIFIER |
| Visit Number |
This is a Correlation Identifier definition compatible with Yorkskhire and Humberside - Interweave-EncounterGrouping See also
|
These define constraints on FHIR data types for systems conforming to this implementation guide.
| EMIS PFS Courses |
EMIS PFS Courses |
| EMIS Practitioner Role |
EMIS Practitioner Role |
| ExtCodeableReference |
(copied from BE eHealth Platform Federal Core Profiles) Extension able to hold a reference and a concept (Temporary solution until https://jira.hl7.org/browse/FHIR-44661 is solved and see Zulip: https://chat.fhir.org/#narrow/stream/179280-fhir.2Finfrastructure-wg/topic/Backporting.20CodeableReference ) |
These define sets of codes used by systems conforming to this implementation guide.
| BARS Referral Code |
Initial documenation for BARS |
| DocumentEntry Class | |
| DocumentEntry Type | |
| DocumentEntry mimeType | |
| Facility Type |
DRAFT |
| Identifier Type |
Identifier Type - override to prevent warnings in validation |
| Medical Record System |
A list of medical record systems. |
| Patient Referral |
Restriction to use referral codes only |
| Practitioner Identifiers |
PractitionerIdentifiers |
| Smoking Status |
Virtually Smoking Status |
| Specialty | |
| UK Common Resource Identifiers |
UK Common Resource Identifiers |
| UK National Insurance Identifiers |
UK NHS National Insurance Identifier E.g. NHS Number (England and Wales) and CHI Number (Scotland) |
| UK Professional License |
UK Professional License E.g. GMC, HCPC, GMP, etc numbers. |
| UK StaffNumber |
UK StaffNumber E.g. SDS User Id and Ministry of Defence Doctor Number |
| VH Condition Code |
VH Condition Type - copy of |
| VH Immunisation Code |
VH Immunisation Code - based on |
| VH Medication Code |
VH Medication Code - based on |
| VH Observation Code |
VH Observation Code - based on HL7 FHIR Observation Guidance. |
| VH Observation Value Code |
VH Observation Value Code - based on HL7 FHIR Observation Guidance. |
These define new code systems used by systems conforming to this implementation guide.
| Medical Record System |
Medical Record Systems |
| Staff Number |
UK Staff Numbers |
| UK Correlation Identifiers |
UK Common Resource Identifiers |
| UK Professional License |
UK Professional License |
| UKNationalIdentifier |
UK National Insurance Provider Identifier |
| Virtually Healthcare Identifiers |
Virtually Healthcare Resource Identifiers |
These define transformations to convert between codes by systems conforming with this implementation guide.
| EMIS Section Headers Mapping |
EMIS Section Headers Mapping |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
eReferral examples
| Bundle Message I12 - BARS REFREQ03 |
BARS Message REFREQ03 converted to I12 Message format |
| Bundle `Message` - Patient Referral |
FHIR Message Patient Referral for Jack Dawkins |
| Condition - Dyspnoea |
Condition Dyspnoea Loosely based on NHS Digital End of Life Care FHIR STU3 - Advance Treatment Preferences Atomic Unit |
| Message Header - Patient Referral |
TODO |
| QuestionnaireResponse eRS Referral Request |
Example of Questionnaire-eRS-Referral-Request - eRS Referral Request Form based Data Capture |
| ServiceRequest - Create |
Example conversion of $ers.createReferral multishortlist to FHIR R4 ServiceRequest in a Clinical Data Repository |
| ServiceRequest BARS REFREQ03 |
BARS Example REFREQ03 converted to ServiceRequest |
eDischarge examples
| Binary Discharge Letter Example |
Binary Discharge Letter |
| Binary Discharge Summary |
Binary Discharge Summary Report as PDF |
| Bundle `Document` - Discharge Report |
FHIR Document Discharge report with multiple panels and individual observations |
| Bundle `Message` R01 - Clinic Report |
FHIR Message Clinic Report - Vital Signs with single Observation Panel |
| Bundle `Message` R01 - Discharge Report |
FHIR Message Discharge Report - Remote Patient Monitoring with multiple Observation Panela and individual Observations |
| Bundle `Message` R01 - with single Observation Panel and individual Observations- Physical and Daily Activity |
FHIR Message Physical Activity Report - with single Observation Panel and individual Observations |
| Bundle `Message` T02 - Discharge Letter |
FHIR Message Discharge Letter |
| Diagnostic Report Physical Activity Example. |
Based on US Physical Activity IG |
| Document Reference Discharge Letter |
TODO |
| Message Header - Activity Report |
Activity Report with single Observation Panel and individual Observations- Physical and Daily Activity |
| Message Header - Clinic Report |
Clinic Report with single Observation Panel Clinic Report Vital Signs |
| Message Header - Discharge Letter |
TODO |
| Message Header - Discharge Report R01 |
DiagnosticReport with multiple Observation Panel Clinic and individual Observations |
Remote Patient Monitoring Vital Signs examples
| Observation CDR - Blood pressure |
Form based Data Capture - Blood pressure See also HL7 Blood pressure For Device based data capture populate device instead of derivedFrom |
| Observation CDR - Body Mass Index |
Form based Data Capture - Body Mass Index See also HL7 FHIR Body Mass Index For Device based data capture populate device instead of derivedFrom |
| Observation CDR - Body height |
Form based Data Capture - Body height See also HL7 FHIR Body height For Device based data capture populate device instead of derivedFrom |
| Observation CDR - Body temperature |
Form based Data Capture - Body temperature See also HL7 FHIR Body temperature For Device based data capture populate device instead of derivedFrom |
| Observation CDR - Body weight |
Form based Data Capture - Body weight See also HL7 FHIR Body weight For Device based data capture populate device instead of derivedFrom |
| Observation CDR - Head circumference |
Form based Data Capture - Head circumference See also HL7 FHIR Head circumference For Device based data capture populate device instead of derivedFrom |
| Observation CDR - Heart rate |
Form based Data Capture - Heart rate See also HL7 FHIR Heart rate For Device based data capture populate device instead of derivedFrom |
| Observation CDR - Oxygen Saturation |
Form based Data Capture - Oxygen Saturation See also Hl7 FHIR Oxygen Saturation For Device based data capture populate device instead of derivedFrom |
| Observation CDR - Respiratory rate |
Form based Data Capture - Respiratory rate See also HL7 FHIR Respiratory rate For Device based data capture populate device instead of derivedFrom |
| Observation CDR - Vital Signs Panel |
See also HL7 FHIR Vital Signs |
| Patient CDR - Rachel Kanfeld |
Clinical Data Reposotory Rachel Kanfeld |
| Questionnaire Response Vital Signs |
Example of Questionnaire-VitalSigns - Vital Signs Form based Data Capture |
Remote Patient Monitoring Exercise Activity examples
| Observation CDR - Activity Duration |
Patient Held Device Data Capture - Activity Duration |
| Observation CDR - Average Heart Rate |
Patient Held Device Data Capture - Average Heart Rate |
| Observation CDR - Calories per activity |
Patient Held Device Data Capture - Calories per activity |
| Observation CDR - Exercise Activity Walking |
Patient Held Device Data Capture - Exercise Activity Walking |
| Observation CDR - Peak Activity Heart Rate |
Patient Held Device Data Capture - Peak Activity Heart Rate |
| Observation CDR - Physical Activity Panel |
Patient Held Device Data Capture - Physical Activity Panel |
| QuestionnaireResponse Exercise Activity |
Example of Questionnaire-DailyPhysicalActivity - Exercise Activity Form based Data Capture |
Remote Patient Monitoring Daily Activity examples
| Observation CDR - Average Resting Heart Rate |
Patient Held Device Data Capture - Average Resting Heart Rate |
| Observation CDR - Calories per Day |
Patient Held Device Data Capture - Calories per Day |
| Observation CDR - Daily Step Count |
Patient Held Device Data Capture - Daily Step Count |
| Observation CDR - Peak daily heart rate |
Patient Held Device Data Capture - Peak daily heart rate |
| QuestionnaireResponse Daily Physical Activity |
Example of Questionnaire-DailyPhysicalActivity - Daily Physical Activity Form based Data Capture |
Care Directory Service examples
| Organization CDR - The Moir Medical Centre (C81010) |
Organisation The Moir Medical Centre (C81010), imported from ODS CSV Downloads |
| Organization NHS England - Leeds Teaching Trust (RR8) |
Organization NHS England ODS FHIR Api - Leeds Teaching Trust (RR8) |
| Organization NHS England - The Moir Medical Centre (C81010) |
Organization NHS England ODS FHIR Api - The Moir Medical Centre (C81010) |
| Patient - Octavia CHISLETT NHS Number: 9449305552 |
Example NHS England PDS Test Pack |
| Patient 9730906181 Example |
Example |
| QuestionnaireResponse pharmacy nomination Example |
Example |
| RelatedPerson CE234750 Example |
Example |