| Package | fhir.virtually.healthcare |
| Type | CapabilityStatement |
| Id | IM1TransactionTPPFacade |
| FHIR Version | R4 |
| Source | https://fhir.virtually.healthcare/https://build.fhir.org/ig/Virtually-Healthcare/R4/CapabilityStatement-IM1TransactionTPPFacade.html |
| URL | https://fhir.virtually.healthcare/CapabilityStatement/IM1TransactionTPPFacade |
| Version | 0.1.1-current |
| Status | draft |
| Date | 2024-10-08 |
| Name | IM1TransactionTPPFacade |
| Title | Facade - IM1 Transaction TPP |
| 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 | |
| Patient | Patient |
| QuestionnaireResponse | QuestionnaireResponse |
| UKCore-Patient | UK Core Patient |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement IM1TransactionTPPFacade
FHIRapplication/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 | y | y | family, given, telecom, birthdate, address-postalcode, gender | |||||
| QuestionnaireResponse | https://fhir.virtually.healthcare/StructureDefinition/QuestionnaireResponse Additional supported profiles: UK Core Questionnaire Response | y |
read, search-type.GET /Patient?{parameters}Conformance to this implementation guide SHOULD be tested via FHIR Validation.
Search Examples
Search for Patient's by surname
GET /Patient?family=Avocet
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | family | string | A patients surname |
| SHALL | given | string | A patients first name |
| SHALL | telecom | token | A patients phone number or email address |
| SHALL | birthdate | date | A patients date of birth |
| SHALL | address-postalcode | string | A patients postcode |
| SHALL | gender | token | A patients gender - administrative |
create.Writeback clinically coded (UK SNOMED CT) consultations to TPP
{
"resourceType": "CapabilityStatement",
"id": "IM1TransactionTPPFacade",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "https://fhir.virtually.healthcare/CapabilityStatement/IM1TransactionTPPFacade",
"version": "0.1.1-current",
"name": "IM1TransactionTPPFacade",
"title": "Facade - IM1 Transaction TPP",
"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 by surname\n\n```\nGET /Patient?family=Avocet\n```\n",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "family",
"type": "string",
"documentation": "A patients surname"
},
{
"name": "given",
"type": "string",
"documentation": "A patients first name"
},
{
"name": "telecom",
"type": "token",
"documentation": "A patients phone number or email address"
},
{
"name": "birthdate",
"type": "date",
"documentation": "A patients date of birth"
},
{
"name": "address-postalcode",
"type": "string",
"documentation": "A patients postcode"
},
{
"name": "gender",
"type": "token",
"documentation": "A patients gender - administrative"
}
]
},
{
"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 TPP",
"interaction": [
{
"code": "create"
}
]
}
]
}
]
}