FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagefhir.nhs.uk.stu3.assets
Resource TypeOperationDefinition
IdeRS-CreateReferral-Operation-1.json
FHIR VersionR3

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

No narrative content found in resource


Source1

{
  "resourceType": "OperationDefinition",
  "url": "https://fhir.nhs.uk/STU3/OperationDefinition/eRS-CreateReferral-Operation-1",
  "version": "1.0.1",
  "name": "eRS-CreateReferral-Operation-1",
  "status": "draft",
  "kind": "operation",
  "date": "2019-12-03T00:00:00+01:00",
  "publisher": "NHS Digital",
  "contact": [
    {
      "name": "Interoperability Team",
      "telecom": [
        {
          "system": "email",
          "value": "interoperabilityteam@nhs.net",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Create a referral for a patient.",
  "code": "ers.createReferral",
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "patient",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The NHS Number of the patient who the referral being created is for. Format: ^[0-9]{10}[%content%]quot;,
      "type": "Identifier"
    },
    {
      "name": "referringClinician",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Required if and only if the logged in user has a role of Referring Clinician Admin.    Format: ^[0-9]{12}[%content%]quot;,
      "type": "Identifier"
    },
    {
      "name": "shortlist",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "A list of 1 to 20 services that will form the shortlist for the referral.",
      "type": "List",
      "profile": {
        "reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Shortlist-List-1"
      }
    },
    {
      "name": "firstReminderFollowUpDays",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "If > 0, the system will send an automated letter to the patient after the number of days stated, if the patient hasn't yet booked or deferred to a Service. If = 0, the system will not send reminder letters for this referral.",
      "type": "unsignedInt"
    },
    {
      "name": "intentionToAddReferralLetter",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Intention to add a referral letter.",
      "type": "Coding",
      "binding": {
        "strength": "required",
        "valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralLetterIntention-1"
      }
    },
    {
      "name": "eReferralPathwayStart",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The e-Referral Pathway Start Date is a derived value of when the Referral To Treatment (RTT) clock starts. You can supply an optional, alternate pathway start date when creating a referral. For more information see the e-RS FHIR API documentation.",
      "type": "Instant"
    },
    {
      "name": "referral",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The referral request that will be created.",
      "type": "ReferralRequest",
      "profile": {
        "reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1"
      }
    }
  ]
}