FHIR IG Statistics: StructureDefinition/NHSDigital-ServiceRequest.StructureDefinition

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "url": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-ServiceRequest",
  "name": "NHSDigitalServiceRequest",
  "status": "draft",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "ServiceRequest",
  "baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "ServiceRequest.id",
        "path": "ServiceRequest.id",
        "short": "Local Referral ID"
      },
      {
        "id": "ServiceRequest.extension",
        "path": "ServiceRequest.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        },
        "min": 0
      },
      {
        "id": "ServiceRequest.extension:ERSAdviceAndGuidance",
        "path": "ServiceRequest.extension",
        "sliceName": "ERSAdviceAndGuidance",
        "short": "ERS Advice and Guidance",
        "definition": "```json\r\n  \"extension\": [\r\n        {\r\n            \"url\": \"https://fhir.nhs.uk/StructureDefinition/Extension-ERS-Referral\",\r\n            \"extension\": [\r\n                {\r\n                    \"url\": \"sourceSystem\",\r\n                    \"valueCode\": \"ers\"\r\n                },\r\n                {\r\n                    \"url\": \"status\",\r\n                    \"valueCode\": \"unbooked\"\r\n                }\r\n            ]\r\n        },\r\n```",
        "min": 0,
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.nhs.uk/StructureDefinition/Extension-ERS-Referral"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.extension:ERSServiceRequestState",
        "path": "ServiceRequest.extension",
        "sliceName": "ERSServiceRequestState",
        "short": "Request Status",
        "definition": "e-RS representation of the state of the referral\r\n\r\n```json\r\n\"extension\": [\r\n        {\r\n            \"url\": \"https://fhir.nhs.uk/StructureDefinition/Extension-ERS-Referral\",\r\n            \"extension\": [\r\n                {\r\n                    \"url\": \"sourceSystem\",\r\n                    \"valueCode\": \"ers\"\r\n                },\r\n                {\r\n                    \"url\": \"status\",\r\n                    \"valueCode\": \"unbooked\"\r\n                }\r\n            ]\r\n        }\r\n    ],\r\n```",
        "min": 0,
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.nhs.uk/StructureDefinition/Extension-eRS-ServiceRequest-State"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.extension:portalLink",
        "path": "ServiceRequest.extension",
        "sliceName": "portalLink",
        "short": "Portal Link",
        "definition": "Deep Link into the specific landing page in MYR\r\n\r\n```json\r\n\"extension\": [\r\n        {\r\n            \"url\": \"https://fhir.nhs.uk/StructureDefinition/Extension-Portal-Link\",\r\n            \"valueUrl\": \"https://virtual.nhs.uk/MyPatientRecords\"\r\n        }\r\n    ],\r\n```",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.nhs.uk/StructureDefinition/Extension-Portal-Link"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.extension:serviceRequestPriority",
        "path": "ServiceRequest.extension",
        "sliceName": "serviceRequestPriority",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.nhs.uk/StructureDefinition/Extension-ServiceRequest-Priority"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.identifier",
        "path": "ServiceRequest.identifier",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "system"
            }
          ],
          "rules": "open"
        },
        "definition": "Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.\r\n\r\n```json\r\n\"identifier\": [\r\n                    {\r\n                        \"system\": \"https://fhir.nhs.uk/Id/UBRN\",\r\n                        \"value\": \"111111111112\"\r\n                    }\r\n                ],\r\n```",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.identifier.value",
        "path": "ServiceRequest.identifier.value",
        "min": 1
      },
      {
        "id": "ServiceRequest.identifier:UBRN",
        "path": "ServiceRequest.identifier",
        "sliceName": "UBRN",
        "short": "Unique Booking Reference Numbe",
        "definition": "Unique Booking Reference Number\r\n(12 digit number used as an internal and external identifier of the referral), known as \"Booking Reference\" Patient side",
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.identifier:UBRN.system",
        "path": "ServiceRequest.identifier.system",
        "min": 1,
        "fixedUri": "https://fhir.nhs.uk/Id/UBRN"
      },
      {
        "id": "ServiceRequest.identifier:UBRN.value",
        "path": "ServiceRequest.identifier.value",
        "min": 1
      },
      {
        "id": "ServiceRequest.basedOn",
        "path": "ServiceRequest.basedOn",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.hl7.org.uk/StructureDefinition/UKCore-CarePlan",
              "https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationRequest",
              "https://fhir.nhs.uk/StructureDefinition/NHSDigital-ServiceRequest"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.basedOn.identifier",
        "path": "ServiceRequest.basedOn.identifier",
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.basedOn.identifier.system",
        "path": "ServiceRequest.basedOn.identifier.system",
        "min": 1
      },
      {
        "id": "ServiceRequest.basedOn.identifier.value",
        "path": "ServiceRequest.basedOn.identifier.value",
        "min": 1
      },
      {
        "id": "ServiceRequest.intent",
        "path": "ServiceRequest.intent",
        "definition": "In **e-RS** default to `order`"
      },
      {
        "id": "ServiceRequest.category",
        "path": "ServiceRequest.category",
        "definition": "A code that classifies the service for searching, sorting and display purposes (e.g. \"Surgical Procedure\").\r\n\r\nAt present the only code in use is Patient Referral\r\n\r\n```json\r\n \"category\": [\r\n        {\r\n            \"coding\": [\r\n                {\r\n                    \"system\": \"http://snomed.info/sct\",\r\n                    \"code\": \"3457005\",\r\n                    \"display\": \"Patient referral\"\r\n                }\r\n            ]\r\n        }\r\n    ],\r\n```",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.category.coding",
        "path": "ServiceRequest.category.coding",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "system"
            }
          ],
          "rules": "open"
        },
        "min": 1
      },
      {
        "id": "ServiceRequest.category.coding.system",
        "path": "ServiceRequest.category.coding.system",
        "min": 1
      },
      {
        "id": "ServiceRequest.category.coding.code",
        "path": "ServiceRequest.category.coding.code",
        "min": 1
      },
      {
        "id": "ServiceRequest.category.coding:BARSCategory",
        "path": "ServiceRequest.category.coding",
        "sliceName": "BARSCategory",
        "binding": {
          "strength": "preferred",
          "valueSet": "https://fhir.nhs.uk/ValueSet/NHSDigital-BARS-message-category"
        }
      },
      {
        "id": "ServiceRequest.category.coding:BARSCategory.system",
        "path": "ServiceRequest.category.coding.system",
        "fixedUri": "https://fhir.nhs.uk/CodeSystem/message-category-servicerequest"
      },
      {
        "id": "ServiceRequest.category.coding:NHSDigitalServiceRequestCategory",
        "path": "ServiceRequest.category.coding",
        "sliceName": "NHSDigitalServiceRequestCategory",
        "binding": {
          "strength": "preferred",
          "valueSet": "https://fhir.nhs.uk/ValueSet/NHSDigital-ServiceRequest-category"
        }
      },
      {
        "id": "ServiceRequest.category.coding:NHSDigitalServiceRequestCategory.system",
        "path": "ServiceRequest.category.coding.system",
        "fixedUri": "http://snomed.info/sct"
      },
      {
        "id": "ServiceRequest.priority",
        "path": "ServiceRequest.priority",
        "definition": "Request Priority Code \r\n\r\nCode for the priority of the referral set by the Referring Clinician\r\n\r\n```json\r\n \"priority\": \"routine\",\r\n```",
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.code",
        "path": "ServiceRequest.code",
        "definition": "A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.\r\n\r\n```json\r\n\"code\": {\r\n        \"coding\":  [\r\n            {\r\n                \"system\": \"http://snomed.info/sct\",\r\n                \"code\": \"73761001\",\r\n                \"display\": \"Colonoscopy\"\r\n            }\r\n        ],\r\n        \"text\": \"Colonoscopy requested\"\r\n    }\r\n```",
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.code.coding",
        "path": "ServiceRequest.code.coding",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "system"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "ServiceRequest.code.coding:SNOMEDProcedureCode",
        "path": "ServiceRequest.code.coding",
        "sliceName": "SNOMEDProcedureCode"
      },
      {
        "id": "ServiceRequest.code.coding:SNOMEDProcedureCode.system",
        "path": "ServiceRequest.code.coding.system",
        "min": 1,
        "fixedUri": "http://snomed.info/sct"
      },
      {
        "id": "ServiceRequest.code.coding:SNOMEDProcedureCode.code",
        "path": "ServiceRequest.code.coding.code",
        "min": 1
      },
      {
        "id": "ServiceRequest.code.coding:ServiceRequestCode",
        "path": "ServiceRequest.code.coding",
        "sliceName": "ServiceRequestCode"
      },
      {
        "id": "ServiceRequest.code.coding:ServiceRequestCode.system",
        "path": "ServiceRequest.code.coding.system",
        "min": 1,
        "fixedUri": "https://fhir.nhs.uk/CodeSystem/ServiceRequest-Code"
      },
      {
        "id": "ServiceRequest.code.coding:ServiceRequestCode.code",
        "path": "ServiceRequest.code.coding.code",
        "min": 1
      },
      {
        "id": "ServiceRequest.subject",
        "path": "ServiceRequest.subject",
        "definition": "On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).\r\n\r\n```json\r\n\"subject\": {\r\n        \"identifier\": {\r\n            \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\r\n            \"value\": \"9999998887\"\r\n        }\r\n    },\r\n```",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Patient"
            ],
            "aggregation": [
              "referenced"
            ]
          }
        ],
        "constraint": [
          {
            "key": "patient-reference",
            "severity": "error",
            "human": "An identifier reference or resource reference must be provided",
            "expression": "(reference.exists() or identifier.exists())"
          },
          {
            "key": "patient-nhs",
            "severity": "error",
            "human": "Length of the supplied NHS Number is wrong.",
            "expression": "identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists()  and identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').value.matches('^([0-9]{10})[%content%]#39;))"
          }
        ],
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.subject.identifier.system",
        "path": "ServiceRequest.subject.identifier.system",
        "min": 1,
        "fixedUri": "https://fhir.nhs.uk/Id/nhs-number"
      },
      {
        "id": "ServiceRequest.subject.identifier.value",
        "path": "ServiceRequest.subject.identifier.value",
        "min": 1
      },
      {
        "id": "ServiceRequest.encounter",
        "path": "ServiceRequest.encounter",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Encounter"
            ],
            "aggregation": [
              "referenced"
            ]
          }
        ]
      },
      {
        "id": "ServiceRequest.authoredOn",
        "path": "ServiceRequest.authoredOn",
        "short": "Referral Initiated Date",
        "definition": "Date the referral was initiated in e-RS\r\n\r\n```json\r\n\"authoredOn\": \"2022-01-11T16:40:00+00:00\",\r\n```",
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.requester",
        "path": "ServiceRequest.requester",
        "definition": "Who is created the Request or the Event. In NHSDigital API's this **SHOULD** always be a PractitionerRole role reference.\r\n\r\n```json\r\n \"requester\": {\r\n        \"reference\": \"#requester\"\r\n    },\r\n```\r\n\r\nThis will reference a `contained` PractitionerRole (note: this resource only contains limited user metadata such as ODS Code, professional code and SDS User Profile Id). This resource should not hold data which is held in SDS, only enough information to identify the SDS Entry,\r\n\r\n```json\r\n{\r\n    \"resourceType\": \"ServiceRequest\",\r\n    \"id\": \"bd1ca5c4-ff49-4f2a-9db4-f5dda0112084\",\r\n    \"meta\": {\r\n        \"lastUpdated\": \"2016-07-11T11:07:22+00:00\"\r\n    },\r\n    \"contained\": [\r\n        {\r\n            \"resourceType\": \"PractitionerRole\",\r\n            \"id\": \"requester\",\r\n            \"practitioner\": {\r\n                \"identifier\": {\r\n                    \"system\": \"https://fhir.hl7.org.uk/Id/gmp-number\",\r\n                    \"value\": \"G8123456\"\r\n                },\r\n                \"display\": \"DR AA BHATIA\"\r\n            },\r\n            \"organization\": {\r\n                \"identifier\": {\r\n                    \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\r\n                    \"value\": \"C81007\"\r\n                },\r\n                \"display\": \"VERNON STREET MEDICAL CTR\"\r\n            },\r\n        }\r\n    ],\r\n    \"requester\": {\r\n        \"reference\": \"#requester\"\r\n    },\r\n```\r\n\r\n**e-RS**\r\n\r\nThe contained PractitionerRole must contain\r\n\r\n- SDS User ID of the Referrer in `practitioner`\r\n- ODS Code of the Referring Organisation in `organization`",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole-Minimal"
            ],
            "aggregation": [
              "contained",
              "referenced"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.performerType",
        "path": "ServiceRequest.performerType",
        "short": "Requested Specialty Name",
        "definition": "**ERS**\r\n\r\nSpecialty used to search for the shortlisted service(s) (if one was used)\r\n\r\n\r\n```json\r\n\"performerType\": {\r\n        \"coding\": [\r\n            {\r\n                \"system\": \"https://fhir.nhs.uk/CodeSystem/eRS-Specialty\",\r\n                \"code\": \"GENERAL_MEDICINE\"\r\n            }\r\n        ]\r\n    },\r\n```\r\n\r\n```json\r\n\"performerType\": {\r\n                    \"coding\": [\r\n                        {\r\n                            \"display\": \"Dermatology\"\r\n                        }\r\n                    ]\r\n                }\r\n```",
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.performerType.coding",
        "path": "ServiceRequest.performerType.coding",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "system"
            }
          ],
          "rules": "open"
        },
        "binding": {
          "strength": "example",
          "valueSet": "https://fhir.nhs.uk/ValueSet/NHSDigital-CareSettingType"
        }
      },
      {
        "id": "ServiceRequest.performerType.coding:treatmentFunctionCodes",
        "path": "ServiceRequest.performerType.coding",
        "sliceName": "treatmentFunctionCodes",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "valueSet": "https://fhir.nhs.uk/ValueSet/NHSDataModelAndDictionary-treatment-function"
        }
      },
      {
        "id": "ServiceRequest.performerType.coding:treatmentFunctionCodes.system",
        "path": "ServiceRequest.performerType.coding.system",
        "fixedUri": "https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-treatment-function"
      },
      {
        "id": "ServiceRequest.performerType.coding:eRSSpecialty",
        "path": "ServiceRequest.performerType.coding",
        "sliceName": "eRSSpecialty",
        "binding": {
          "strength": "required",
          "valueSet": "https://fhir.nhs.uk/ValueSet/NHSDigital-eRS-Specialty"
        }
      },
      {
        "id": "ServiceRequest.performerType.coding:eRSSpecialty.system",
        "path": "ServiceRequest.performerType.coding.system",
        "fixedUri": "https://fhir.nhs.uk/CodeSystem/eRS-Specialty"
      },
      {
        "id": "ServiceRequest.performer",
        "path": "ServiceRequest.performer",
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.performer.identifier",
        "path": "ServiceRequest.performer.identifier",
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.performer.identifier.system",
        "path": "ServiceRequest.performer.identifier.system",
        "min": 1
      },
      {
        "id": "ServiceRequest.performer.identifier.value",
        "path": "ServiceRequest.performer.identifier.value",
        "min": 1
      },
      {
        "id": "ServiceRequest.reasonCode",
        "path": "ServiceRequest.reasonCode",
        "definition": "An explanation or justification for why this service is being requested in coded or textual form.   This is often for billing purposes.  May relate to the resources referred to in `supportingInfo`.\r\n\r\n```json\r\n\"reasonCode\":  [\r\n        {\r\n            \"coding\":  [\r\n                {\r\n                    \"system\": \"http://snomed.info/sct\",\r\n                    \"code\": \"271835004\",\r\n                    \"display\": \"Abdominal distension, gaseous\"\r\n                }\r\n            ],\r\n            \"text\": \"Swollen abdomen\"\r\n        }\r\n    ]\r\n```",
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.supportingInfo",
        "path": "ServiceRequest.supportingInfo",
        "definition": "Additional clinical information about the patient or specimen that may influence the services or their interpretations.     This information includes diagnosis, clinical findings and other observations.  In laboratory ordering these are typically referred to as \"ask at order entry questions (AOEs)\".  This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example,  reporting the amount of inspired oxygen for blood gas measurements.\r\n\r\n```json\r\n\"supportingInfo\": [\r\n        {\r\n            \"type\" : \"DocumentReference\",\r\n            \"reference\": \"DocumentReference/5da894e0-a57e-43e9-a1a1-e283a484003c\"\r\n        },\r\n        {\r\n            \"type\" : \"QuestionnaireResponse\",\r\n            \"reference\" : \"QuestionnaireResponse/d9d4cf80-3f9d-4435-9f3b-e6efb09ad654\"\r\n        }\r\n    ],\r\n```",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Resource",
              "https://fhir.nhs.uk/StructureDefinition/NHSDigital-DocumentReference"
            ],
            "aggregation": [
              "referenced"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "ServiceRequest.note",
        "path": "ServiceRequest.note",
        "comment": "For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time.  This element may need to be included in narrative because of the potential for modifying information.  *Annotations SHOULD NOT* be used to communicate \"modifying\" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).\r\n\r\n```json\r\n\"note\": [\r\n        {\r\n            \"text\": \"Please advise me on this patient who ...(information about patient)\"\r\n        }\r\n    ]\r\n```",
        "mustSupport": true
      }
    ]
  }
}