Package | fhir.virtually.healthcare |
Type | CapabilityStatement |
Id | IM1TransactionEMISFacade |
FHIR Version | R4 |
Source | https://fhir.virtually.healthcare/https://build.fhir.org/ig/Virtually-Healthcare/R4/CapabilityStatement-IM1TransactionEMISFacade.html |
URL | https://fhir.virtually.healthcare/CapabilityStatement/IM1TransactionEMISFacade |
Version | 0.1.1-current |
Status | draft |
Date | 2024-10-08 |
Name | IM1TransactionEMISFacade |
Title | Facade - IM1 Transaction EMIS |
Realm | us |
Authority | hl7 |
Description | This is a [Service Facade](ActorDefinition-ServiceFacade.html) to [IM1 Transaction](https://digital.nhs.uk/services/gp-it-futures-systems/im1-pairing-integration/interface-mechanisms-guidance#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. |
Kind | requirements |
No resources found
StructureDefinition | |
AllergyIntolerance | AllergyIntolerance |
DocumentReference | DocumentReference |
Immunization | Immunization |
MedicationRequest | MedicationRequest |
Observation | Observation |
Patient | Patient |
QuestionnaireResponse | QuestionnaireResponse |
Task | Task |
UKCore-Patient | UK Core Patient |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement IM1TransactionEMISFacade
application/fhir+xml
, application/fhir+json
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.
server
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
read
, search-type
.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 | identifier | token | A patients NHS Number e.g. |
SHALL | name | string | A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text |
SHALL | birthdate | date | A patients date of birth |
search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | Who the sensitivity is for |
search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | Who has the condition? |
search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | Who/what is the subject of the document |
search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | The patient for the vaccination record |
search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | Returns prescriptions for a specific patient |
SHALL | authoredon | date | Return prescriptions written on this date |
search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | The subject that the observation is about (if patient) |
search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | Search by patient |
search-type
.Consultations
Not fully implemented, used for testing writebacks.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | Who and/or what the composition is about |
SHALL | date | date | Composition editing time |
create
.Writeback clinically coded (UK SNOMED CT) consultations to EMIS
create
.search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | schedule | reference | The Schedule Resource that we are seeking a slot within |
search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | service-type | token | The type of appointments that can be booked into associated slot(s) |
SHALL | date | date | Search for Schedule resources that have a period that contains this date specified |
{ "resourceType": "CapabilityStatement", "id": "IM1TransactionEMISFacade", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "url": "https://fhir.virtually.healthcare/CapabilityStatement/IM1TransactionEMISFacade", "version": "0.1.1-current", "name": "IM1TransactionEMISFacade", "title": "Facade - IM1 Transaction EMIS", "status": "draft", "experimental": false, "date": "2024-10-08", "publisher": "Virtually Healthcare", "contact": [ { "name": "Virtually Healthcare", "telecom": [ { "system": "url", "value": "https://virtually.healthcare" } ] } ], "description": "This is a [Service Facade](ActorDefinition-ServiceFacade.html) to [IM1 Transaction](https://digital.nhs.uk/services/gp-it-futures-systems/im1-pairing-integration/interface-mechanisms-guidance#transaction)\n\nThis 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.", "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" } ], "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" }, { "code": "search-type" } ], "searchParam": [ { "name": "identifier", "type": "token", "documentation": "A patients NHS Number e.g. `identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210`" }, { "name": "name", "type": "string", "documentation": "A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text" }, { "name": "birthdate", "type": "date", "documentation": "A patients date of birth" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "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" } ] }, { "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?" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ], "type": "Observation", "profile": "https://fhir.virtually.healthcare/StructureDefinition/Observation", "supportedProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation" ], "interaction": [ { "code": "search-type" } ], "searchParam": [ { "name": "patient", "type": "reference", "documentation": "The subject that the observation is about (if patient)" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Task", "profile": "https://fhir.virtually.healthcare/StructureDefinition/Task", "supportedProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Task" ], "interaction": [ { "code": "search-type" } ], "searchParam": [ { "name": "patient", "type": "reference", "documentation": "Search by patient" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Composition", "profile": "http://hl7.org/fhir/StructureDefinition/Composition", "supportedProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Composition" ], "documentation": "Consultations\n\nNot fully implemented, used for testing writebacks.", "interaction": [ { "code": "search-type" } ], "searchParam": [ { "name": "patient", "type": "reference", "documentation": "Who and/or what the composition is about" }, { "name": "date", "type": "date", "documentation": "Composition editing time" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "QuestionnaireResponse", "profile": "https://fhir.virtually.healthcare/StructureDefinition/QuestionnaireResponse", "supportedProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse" ], "documentation": "Writeback clinically coded (UK SNOMED CT) consultations to EMIS", "interaction": [ { "code": "create" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Appointment", "profile": "http://hl7.org/fhir/StructureDefinition/Appointment", "supportedProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment" ], "interaction": [ { "code": "create" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Slot", "profile": "http://hl7.org/fhir/StructureDefinition/Slot", "supportedProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Slot" ], "interaction": [ { "code": "search-type" } ], "searchParam": [ { "name": "schedule", "type": "reference", "documentation": "The Schedule Resource that we are seeking a slot within" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Schedule", "profile": "http://hl7.org/fhir/StructureDefinition/Schedule", "supportedProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule" ], "interaction": [ { "code": "search-type" } ], "searchParam": [ { "name": "service-type", "type": "token", "documentation": "The type of appointments that can be booked into associated slot(s)" }, { "name": "date", "type": "date", "documentation": "Search for Schedule resources that have a period that contains this date specified" } ] } ] } ] }