FHIR IG Statistics: StructureDefinition/DataStandardsWales-PSOM-Task

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "DataStandardsWales-PSOM-Task",
  "url": "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-PSOM-Task",
  "name": "DataStandardsWalesPSOMTask",
  "title": "Data Standards Wales PSOM Task",
  "status": "draft",
  "publisher": "NHS Wales",
  "contact": [
    {
      "name": "Data Standards",
      "telecom": [
        {
          "system": "email",
          "value": "data.standards@wales.nhs.uk",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Defines how a Task is used to ask for a Questionnaire to be completed. Each Task represents one PROMs Tool within a Collection Event.\r\n\r\nThis profile is based on the UKCore-Task and is heavily influenced by the [SDCTaskQuestionnaire](http://hl7.org/fhir/uv/sdc/STU3/StructureDefinition-sdc-task.profile.json.html).",
  "copyright": "© 2023 NHS Wales.",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "PROMs-Metadata-2024004",
      "name": "NHS Wales DSCN Metadata Mapping"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "Task",
  "baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Task",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Task",
        "path": "Task",
        "constraint": [
          {
            "key": "PSOM-Task-01",
            "severity": "error",
            "human": "If the Task contains a questionnaire response, the completion date SHALL be provided.",
            "expression": "output.where(type.coding.system = 'http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and type.coding.code = 'questionnaire-response').exists() implies executionPeriod.end.exists()"
          }
        ]
      },
      {
        "id": "Task.code",
        "path": "Task.code",
        "min": 1,
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/uv/sdc/CodeSystem/temp",
              "code": "complete-questionnaire"
            }
          ]
        }
      },
      {
        "id": "Task.focus",
        "path": "Task.focus",
        "comment": "For referencing the CarePlan, the `.basedOn` or `.focus` element could be used. The SDC IG adopts the latter approach.  However, in our use case it is discouraged to use this element to refer to the CarePlan because `CarePlan.activity` already contains a reference to the Task. This would lead to a circular reference which could potentially lead to issues when updating or deleting resources."
      },
      {
        "id": "Task.executionPeriod",
        "path": "Task.executionPeriod",
        "min": 1
      },
      {
        "id": "Task.executionPeriod.start",
        "path": "Task.executionPeriod.start",
        "short": "PROMs Issued Date",
        "definition": "The date and time the PROMs form was issued to the patient. This is populated by the PROMs platform.",
        "min": 1,
        "mapping": [
          {
            "identity": "PROMs-Metadata-2024004",
            "map": "MPRPX002X",
            "comment": "PROMs Issued Date"
          }
        ]
      },
      {
        "id": "Task.executionPeriod.end",
        "path": "Task.executionPeriod.end",
        "short": "PROMs Completion Date & Time",
        "definition": "The date and time the PROMs form was completed (or when the last item was recorded for incomplete records). If only the date component is captured, this can be provided without a time component. This is populated by the PROMs platform.",
        "condition": [
          "PSOM-Task-01"
        ],
        "mapping": [
          {
            "identity": "PROMs-Metadata-2024004",
            "map": "MPRPX003X",
            "comment": "PROMs Completion Date & Time"
          }
        ]
      },
      {
        "id": "Task.location",
        "path": "Task.location",
        "short": "Event Location Code",
        "definition": "The code of the site where the PROMs form was initiated. This is populated by the Health Board system.",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Location"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "PROMs-Metadata-2024004",
            "map": "MPRPX001X",
            "comment": "Event Location Code (implicit, main mapping is on Location.identifier)"
          }
        ]
      },
      {
        "id": "Task.reasonCode",
        "path": "Task.reasonCode",
        "short": "PROMs Trigger Event Type",
        "definition": "The national code representing the type of healthcare or administrative event that triggers a requirement for a questionnaire (or onboarding process) to be completed.",
        "min": 1,
        "binding": {
          "strength": "extensible",
          "valueSet": "https://fhir.nhs.wales/ValueSet/DataStandardsWales-PSOM-TriggerEventType"
        },
        "mapping": [
          {
            "identity": "PROMs-Metadata-2024004",
            "map": "MPRPX007X",
            "comment": "PROMs Trigger Event Type"
          }
        ]
      },
      {
        "id": "Task.input",
        "path": "Task.input",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "type"
            }
          ],
          "rules": "open"
        },
        "definition": "Additional information that may be needed in the execution of the Task populated by the Health Board.",
        "min": 2
      },
      {
        "id": "Task.input:promsTriggerEventDate",
        "path": "Task.input",
        "sliceName": "promsTriggerEventDate",
        "definition": "Indicates the date of the event that triggers a requirement for a questionnaire (or onboarding process) to be completed, irrespective of the date that the PROMs form was triggered/issued.",
        "comment": "Mandatory for healthcare pathway activity-based event types, e.g. referrals, outpatient appointments, interventions, etc. (i.e. not mandatory for event types not directly resulting from these, such as clinician or patient initiated event types).",
        "max": "1"
      },
      {
        "id": "Task.input:promsTriggerEventDate.type",
        "path": "Task.input.type",
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "https://fhir.nhs.wales/CodeSystem/DataStandardsWales-PSOM-TaskInputType",
              "code": "MPRPX013X"
            }
          ]
        }
      },
      {
        "id": "Task.input:promsTriggerEventDate.value[x]",
        "path": "Task.input.value[x]",
        "short": "PROMs Trigger Event Date",
        "definition": "The date of the event that triggers a requirement for a questionnaire (or onboarding process) to be completed, irrespective of the date that the PROMs form was triggered/issued.",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "mapping": [
          {
            "identity": "PROMs-Metadata-2024004",
            "map": "MPRPX013X",
            "comment": "PROMs Trigger Event Date"
          }
        ]
      },
      {
        "id": "Task.input:promsLaterality",
        "path": "Task.input",
        "sliceName": "promsLaterality",
        "definition": "Indicates the anatomical side associated with the questionnaire being completed.",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Task.input:promsLaterality.type",
        "path": "Task.input.type",
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "https://fhir.nhs.wales/CodeSystem/DataStandardsWales-PSOM-TaskInputType",
              "code": "MDEPX004X"
            }
          ]
        }
      },
      {
        "id": "Task.input:promsLaterality.value[x]",
        "path": "Task.input.value[x]",
        "short": "PROMs Laterality",
        "definition": "The anatomical side associated with the questionnaire being completed.",
        "comment": "Note that if a patient completes a questionnaire for both left and right sides, two records should be generated and labelled as per the specified value set. Note also that this item is intended to capture the laterality specified as part of the patient’s PROMs pathway record as opposed to any patient reported laterality information which would be captured within the form itself.",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "required",
          "description": "Identifies the laterality",
          "valueSet": "https://fhir.nhs.wales/ValueSet/DataStandardsWales-PSOM-PROMsLaterality"
        },
        "mapping": [
          {
            "identity": "PROMs-Metadata-2024004",
            "map": "MDEPX004X",
            "comment": "PROMs Laterality"
          }
        ]
      },
      {
        "id": "Task.input:questionnaire",
        "path": "Task.input",
        "sliceName": "questionnaire",
        "definition": "Indicates the questionnaire to be completed.",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Task.input:questionnaire.type",
        "path": "Task.input.type",
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/uv/sdc/CodeSystem/temp",
              "code": "questionnaire"
            }
          ]
        }
      },
      {
        "id": "Task.input:questionnaire.value[x]",
        "path": "Task.input.value[x]",
        "short": "(Local) PROMs Tool",
        "definition": "The Questionnaire that is requested to be filled in. A reference to the canonical identifier including the `.version` (MPRPX012X) of the PROMs Tool SHALL be implemented, to specify the correct version.",
        "type": [
          {
            "code": "canonical",
            "targetProfile": [
              "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "PROMs-Metadata-2024004",
            "map": "MPRPX006X",
            "comment": "PROMs Tool (implicit, main mapping is on Questionnaire.url)"
          },
          {
            "identity": "PROMs-Metadata-2024004",
            "map": "MPRPX010X",
            "comment": "Local PROMs Tool (implicit, main mapping is on Questionnaire.url)"
          },
          {
            "identity": "PROMs-Metadata-2024004",
            "map": "MPRPX012X",
            "comment": "PROMs Data Standard Version (implicit, main mapping is on Questionnaire.version)"
          }
        ]
      },
      {
        "id": "Task.input:responseEndpoint",
        "path": "Task.input",
        "sliceName": "responseEndpoint",
        "definition": "Indicates an endpoint the form should be posted to on completion."
      },
      {
        "id": "Task.input:responseEndpoint.type",
        "path": "Task.input.type",
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/uv/sdc/CodeSystem/temp",
              "code": "response-endpoint"
            }
          ]
        }
      },
      {
        "id": "Task.input:responseEndpoint.value[x]",
        "path": "Task.input.value[x]",
        "type": [
          {
            "code": "url"
          }
        ]
      },
      {
        "id": "Task.output",
        "path": "Task.output",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "type"
            }
          ],
          "rules": "open"
        },
        "definition": "Outputs produced by the Task populated by the PROMs platform."
      },
      {
        "id": "Task.output:response",
        "path": "Task.output",
        "sliceName": "response",
        "max": "1",
        "condition": [
          "PSOM-Task-01"
        ]
      },
      {
        "id": "Task.output:response.type",
        "path": "Task.output.type",
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/uv/sdc/CodeSystem/temp",
              "code": "questionnaire-response"
            }
          ]
        }
      },
      {
        "id": "Task.output:response.value[x]",
        "path": "Task.output.value[x]",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-PSOM-QuestionnaireResponse"
            ]
          }
        ]
      }
    ]
  }
}