FHIR IG Statistics: CapabilityStatement/NHSEFacade

Resources that use this resource

No resources found

Resources that this resource uses

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType": "CapabilityStatement",
  "id": "NHSEFacade",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://fhir.virtually.healthcare/CapabilityStatement/NHSEFacade",
  "version": "0.1.1-current",
  "name": "NHSEnglandFacade",
  "title": "NHS England Service Facade",
  "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 [Personal Demographics Service - FHIR API](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir) and [Organisation Data Service - FHIR API](https://digital.nhs.uk/developer/api-catalogue/organisation-data-service-fhir)\n\nThis facade is related to [IHE Patient Demographics Query for Mobile (PDQm)](https://profiles.ihe.net/ITI/PDQm/) and [IHE Mobile Care Services Discovery (mCSD)](https://profiles.ihe.net/ITI/mCSD/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"
            }
          ],
          "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 patients name"
            },
            {
              "name": "family",
              "type": "string",
              "documentation": "A patients surname"
            },
            {
              "name": "given",
              "type": "string",
              "documentation": "A patients first name"
            },
            {
              "name": "birthdate",
              "type": "date",
              "documentation": "A patients date of birth"
            },
            {
              "name": "gender",
              "type": "token",
              "documentation": "A patients gender - administrative"
            },
            {
              "name": "death-date",
              "type": "token",
              "documentation": "A patients date of birth"
            },
            {
              "name": "address-postalcode",
              "type": "string",
              "documentation": "A patients postcode"
            },
            {
              "name": "general-practitioner",
              "type": "token",
              "documentation": "A patients general practice"
            },
            {
              "name": "email",
              "type": "token",
              "documentation": "A patients email address"
            },
            {
              "name": "phone",
              "type": "token",
              "documentation": "A patients phone number"
            }
          ]
        },
        {
          "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"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "questionnaire",
              "type": "reference",
              "documentation": "The questionnaire the answers are provided for, e.g. `questionnaire=https://fhir.virtually.healthcare/Questionnaire/PDSPatientPreferences`"
            },
            {
              "name": "patient",
              "type": "reference",
              "documentation": "The patient that is the subject of the questionnaire response, e.g. `patient=Patient/9449304424`"
            },
            {
              "name": "patient:identifier",
              "type": "token",
              "documentation": "The patient identifier that is the subject of the questionnaire response, e.g. `patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9449304424`"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "RelatedPerson",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/RelatedPerson",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient:identifier",
              "type": "token",
              "documentation": "The patient identifier this related person is related to, e.g. `patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9730906181`"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Organization",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/Organization",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
          ],
          "documentation": "\n```\nGET /Organization?{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 Organization's for a patient with a ODS Code of RR8\n\n```\nGET /Organization?identifier=https://fhir.nhs.uk/Id/ods-organization-code|RR8\n```\n",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "identifier",
              "type": "token",
              "documentation": "A organisations ODS Code e.g. `identifier=https://fhir.nhs.uk/Id/ods-organization-code|RR8`"
            },
            {
              "name": "name",
              "type": "string",
              "documentation": "A portion of the organization's name or alias"
            },
            {
              "name": "active",
              "type": "token",
              "documentation": "Is the Organization record active"
            },
            {
              "name": "address-postalcode",
              "type": "string",
              "documentation": "A postal code specified in an address"
            },
            {
              "name": "address-city",
              "type": "string",
              "documentation": "A city specified in an address"
            },
            {
              "name": "ods-org-primaryRole",
              "type": "token",
              "documentation": "organisation ods primary role"
            },
            {
              "name": "type",
              "type": "token",
              "documentation": "A code for the type of organization"
            }
          ]
        }
      ]
    }
  ]
}