{
  "description": "Get a patient's clinical record in a structured coded format.",
  "_filename": "GPConnect-GetStructuredRecord-Operation-1.json",
  "package_name": "uk.gpc.struct",
  "date": "2020-02-11",
  "system": false,
  "publisher": "NHS Digital",
  "instance": false,
  "name": "GPConnect-GetStructuredRecord-Operation",
  "type": "true",
  "experimental": null,
  "resourceType": "OperationDefinition",
  "title": null,
  "package_version": "1.5.0",
  "status": "draft",
  "id": "3040051c-9271-4879-9132-4ed69f86340d",
  "resource": [ "Patient" ],
  "kind": "operation",
  "url": "https://fhir.nhs.uk/STU3/OperationDefinition/GPConnect-GetStructuredRecord-Operation-1",
  "code": "gpc.getstructuredrecord",
  "version": "1.15.0",
  "contact": [ {
    "name": "Interoperability Team",
    "telecom": [ {
      "value": "interoperabilityteam@nhs.net",
      "system": "email"
    } ]
  } ],
  "parameter": [ {
    "max": "1",
    "min": 1,
    "use": "in",
    "name": "patientNHSNumber",
    "type": "Identifier",
    "documentation": "The NHS number of the patient whose record is being extracted, which must be traced or verified against the national demographics index."
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "includeAllergies",
    "part": [ {
      "max": "1",
      "min": 1,
      "use": "in",
      "name": "includeResolvedAllergies",
      "type": "boolean",
      "documentation": "Include resolved allergies and intolerances in the response bundle."
    } ],
    "documentation": "Include resources representing a patient's allergies and intolerances in the response bundle. By default, resolved allergies and intolerances are not included."
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "includeMedication",
    "part": [ {
      "max": "1",
      "min": 0,
      "use": "in",
      "name": "includePrescriptionIssues",
      "type": "boolean",
      "documentation": "Include each prescription issue in the response. By default, prescription issues are not included."
    }, {
      "max": "1",
      "min": 0,
      "use": "in",
      "name": "medicationSearchFromDate",
      "type": "date",
      "documentation": "Restrict the patient's medication record to those that are active on or after medicationSearchFromDate."
    } ],
    "documentation": "Include resources representing a patient's medication record in the response bundle."
  }, {
    "max": "1",
    "min": 1,
    "use": "out",
    "name": "response",
    "type": "Bundle",
    "profile": {
      "reference": "https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-StructuredRecord-Bundle-1"
    },
    "documentation": "The patient structured coded record. This is returned as a bundle containing resources representing the record as requested by the given input parameters."
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "includeConsultations",
    "part": [ {
      "max": "1",
      "min": 0,
      "use": "in",
      "name": "consultationSearchPeriod",
      "type": "Period",
      "documentation": "Restrict consultations by defining a time period."
    }, {
      "max": "1",
      "min": 0,
      "use": "in",
      "name": "includeNumberOfMostRecent",
      "type": "positiveInt",
      "documentation": "Limit the number of returned consultations."
    } ],
    "documentation": "Include consultations in the response."
  }, {
    "max": "*",
    "min": 0,
    "use": "in",
    "name": "includeProblems",
    "part": [ {
      "max": "1",
      "min": 0,
      "use": "in",
      "name": "filterStatus",
      "type": "code",
      "binding": {
        "strength": "required",
        "valueSetUri": "http://hl7.org/fhir/ValueSet/condition-clinical"
      },
      "documentation": "Restrict the problems that are returned by their clinical status."
    }, {
      "max": "1",
      "min": 0,
      "use": "in",
      "name": "filterSignificance",
      "type": "code",
      "binding": {
        "strength": "required",
        "valueSetUri": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ProblemSignificance-1"
      },
      "documentation": "Restrict the problems that are returned by their clinical significance."
    } ],
    "documentation": "Include problems in the response."
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "includeImmunisations",
    "part": [ {
      "max": "1",
      "min": 0,
      "use": "in",
      "name": "includeNotGiven",
      "type": "boolean",
      "documentation": "Include immunisations not given in the response."
    } ],
    "documentation": "Include immunisations in the response."
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "includeUncategorisedData",
    "part": [ {
      "max": "1",
      "min": 0,
      "use": "in",
      "name": "uncategorisedDataSearchPeriod",
      "type": "Period",
      "documentation": "Restrict uncategorised data by defining a time period."
    } ],
    "documentation": "Include uncategorised data in the response."
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "includeDiaryEntries",
    "part": [ {
      "max": "1",
      "min": 0,
      "use": "in",
      "name": "diaryEntriesSearchDate",
      "type": "date",
      "documentation": "Include diary entries prior to the the diaryEntriesSearchDate."
    } ],
    "documentation": "Include diary entries in the response."
  } ]
}