Notice
- Important: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
- This Implementation Guide is currently in Draft and SHOULD NOT be used for development or active implementation without express direction from the NHS England Genomics Unit.
StructureDefinition NHSEngland-Task-Genomics
The core workflow resource for managing processing of a ServiceRequest from order through to delivery of a DiagnosticReport and completion is Task. Task tracking is a core requirement of the central Genomic Medicine Service.
Each ServiceRequest submitted will instantiate a series of High Level Tasks, which MAY be assigned to different organizations for managing the test request e.g. Sample Processing, Interpretation, Reporting etc. The full list of possible Task types/codes, their associated business statuses, and status reasons is pending internal review.
Tasks will be automatically created by the central broker but updates to statuses and attachment of input/output resources is the responsibility of the assigned organizations.
An illustrative diagram of the links between ServiceRequests and Tasks are provided below (for the initial sample processing). Note: not all resource links are represented, to increase legibility of the diagram. In most cases, the full library of 10 tasks, as defined within Genomic-Task-Code, will be 'spun-up', on submission of a Test order. Tasks related to Samples may be duplicated per Sample to allow tracking of work related to individual Samples as part of the same test request, or equally, may be omitted as in the case of Re-Analysis or Re-Interpretation where data from an existing sample is used, eliminating the need for additional wet-work. For the full cardinality breakdown see further guidance for the Task.code element.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.nhs.uk/StructureDefinition/NHSEngland-Task-Genomics | NHS England Genomics | trial-use |
| Canonical_URL | Status | Current_Version | Last_Updated | Description |
|---|---|---|---|---|
| https://fhir.nhs.uk/StructureDefinition/NHSEngland-Task-Genomics | active | 0.3.0 | 2026-04-16 | This profile defines the Genomics constraints and extensions on the International FHIR resource Task. |
Tree View
| NHSEngland_Task_Genomics (Task) | C | Task | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | 0..* | Identifier | |
| instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) |
| instantiatesUri | Σ | 0..1 | uri |
| basedOn | Σ C | 0..0 | Reference(Resource) |
| groupIdentifier | Σ | 0..1 | Identifier |
| partOf | Σ C | 0..* | Reference(NHSEngland_Task_Genomics) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(UKCoreOrganization | https://fhir.nhs.uk/StructureDefinition/NHSEngland-Organization-Genomics) |
| display | Σ | 0..1 | string |
| status | Σ ?! | 1..1 | codeBinding |
| statusReason | Σ | 0..1 | CodeableConceptBinding |
| businessStatus | Σ | 0..1 | CodeableConceptBinding |
| intent | Σ | 1..1 | codeBinding |
| priority | 0..1 | codeBinding | |
| code | Σ | 1..1 | CodeableConceptBinding |
| description | Σ | 0..0 | string |
| focus | Σ C | 1..1 | Reference(NHSEngland_ServiceRequest_Genomics) |
| for | Σ C | 1..1 | Reference(Resource | NHSEngland_Patient_Genomics) |
| encounter | Σ C | 0..0 | Reference(Encounter) |
| executionPeriod | Σ C | 0..1 | Period |
| authoredOn | C | 1..1 | dateTime |
| lastModified | Σ C | 0..1 | dateTime |
| requester | Σ C | 1..1 | Reference(NHSEngland_PractitionerRole_Genomics) |
| performerType | 0..0 | CodeableConceptBinding | |
| owner | Σ C | 0..1 | Reference(UKCoreOrganization) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 1..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uriFixed Value |
| value | Σ | 0..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| display | Σ | 0..1 | string |
| location | Σ C | 0..0 | Reference(Location) |
| reasonCode | 0..0 | CodeableConcept | |
| reasonReference | C | 0..0 | Reference(Resource) |
| insurance | C | 0..0 | Reference(ClaimResponse | Coverage) |
| note | 0..* | Annotation | |
| relevantHistory | C | 0..0 | Reference(Provenance) |
| restriction | 0..0 | BackboneElement | |
| input | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| type | 1..1 | CodeableConceptBinding | |
| value[x] | 1..1 | ||
| valueAddress | Address | ||
| valueAge | Age | ||
| valueAnnotation | Annotation | ||
| valueAttachment | Attachment | ||
| valueBase64Binary | base64Binary | ||
| valueBoolean | boolean | ||
| valueCanonical | canonical | ||
| valueCode | code | ||
| valueCodeableConcept | CodeableConcept | ||
| valueCoding | Coding | ||
| valueContactDetail | ContactDetail | ||
| valueContactPoint | ContactPoint | ||
| valueContributor | Contributor | ||
| valueCount | Count | ||
| valueDataRequirement | DataRequirement | ||
| valueDate | date | ||
| valueDateTime | dateTime | ||
| valueDecimal | decimal | ||
| valueDistance | Distance | ||
| valueDosage | Dosage | ||
| valueDuration | Duration | ||
| valueExpression | Expression | ||
| valueHumanName | HumanName | ||
| valueId | id | ||
| valueIdentifier | Identifier | ||
| valueInstant | instant | ||
| valueInteger | integer | ||
| valueMarkdown | markdown | ||
| valueMeta | Meta | ||
| valueMoney | Money | ||
| valueOid | oid | ||
| valueParameterDefinition | ParameterDefinition | ||
| valuePeriod | Period | ||
| valuePositiveInt | positiveInt | ||
| valueQuantity | Quantity | ||
| valueRange | Range | ||
| valueRatio | Ratio | ||
| valueReference | Reference | ||
| valueRelatedArtifact | RelatedArtifact | ||
| valueSampledData | SampledData | ||
| valueSignature | Signature | ||
| valueString | string | ||
| valueTime | time | ||
| valueTiming | Timing | ||
| valueTriggerDefinition | TriggerDefinition | ||
| valueUnsignedInt | unsignedInt | ||
| valueUri | uri | ||
| valueUrl | url | ||
| valueUsageContext | UsageContext | ||
| valueUuid | uuid | ||
| output | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| type | 1..1 | CodeableConceptBinding | |
| value[x] | 1..1 | ||
| valueAddress | Address | ||
| valueAge | Age | ||
| valueAnnotation | Annotation | ||
| valueAttachment | Attachment | ||
| valueBase64Binary | base64Binary | ||
| valueBoolean | boolean | ||
| valueCanonical | canonical | ||
| valueCode | code | ||
| valueCodeableConcept | CodeableConcept | ||
| valueCoding | Coding | ||
| valueContactDetail | ContactDetail | ||
| valueContactPoint | ContactPoint | ||
| valueContributor | Contributor | ||
| valueCount | Count | ||
| valueDataRequirement | DataRequirement | ||
| valueDate | date | ||
| valueDateTime | dateTime | ||
| valueDecimal | decimal | ||
| valueDistance | Distance | ||
| valueDosage | Dosage | ||
| valueDuration | Duration | ||
| valueExpression | Expression | ||
| valueHumanName | HumanName | ||
| valueId | id | ||
| valueIdentifier | Identifier | ||
| valueInstant | instant | ||
| valueInteger | integer | ||
| valueMarkdown | markdown | ||
| valueMeta | Meta | ||
| valueMoney | Money | ||
| valueOid | oid | ||
| valueParameterDefinition | ParameterDefinition | ||
| valuePeriod | Period | ||
| valuePositiveInt | positiveInt | ||
| valueQuantity | Quantity | ||
| valueRange | Range | ||
| valueRatio | Ratio | ||
| valueReference | Reference | ||
| valueRelatedArtifact | RelatedArtifact | ||
| valueSampledData | SampledData | ||
| valueSignature | Signature | ||
| valueString | string | ||
| valueTime | time | ||
| valueTiming | Timing | ||
| valueTriggerDefinition | TriggerDefinition | ||
| valueUnsignedInt | unsignedInt | ||
| valueUri | uri | ||
| valueUrl | url | ||
| valueUsageContext | UsageContext | ||
| valueUuid | uuid |
Detailed Descriptions
| Task | |||
| Short | A task to be performed | ||
| Definition | A task to be performed. | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.id | |||
| Short | Logical id of this artifact | ||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
| Cardinality | 0..1 | ||
| Type | id | ||
| Summary | True | ||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.meta | |||
| Short | Metadata about the resource | ||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Modifier | True | ||
| Summary | True | ||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||
| Cardinality | 0..1 | ||
| Type | Narrative | ||
| Alias | narrative, html, xhtml, display | ||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.contained | |||
| Short | Contained, inline Resources | ||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
| Cardinality | 0..* | ||
| Type | Resource | ||
| Alias | inline resources, anonymous resources, contained resources | ||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||
| Mappings |
| ||
| Task.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Alias | extensions, user content | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.identifier | |||
| Short | Task Instance Identifier | ||
| Definition | The business identifier for this task. | ||
| Cardinality | 0..* | ||
| Type | Identifier | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.instantiatesCanonical | |||
| Short | Formal definition of task | ||
| Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. | ||
| Cardinality | 0..1 | ||
| Type | canonical(ActivityDefinition) | ||
| Summary | True | ||
| Requirements | Enables a formal definition of how he task is to be performed, enabling automation. | ||
| Comments | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.instantiatesUri | |||
| Short | Formal definition of task | ||
| Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation to be associated with a task), enabling automation. | ||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.basedOn | |||
| Short | Request fulfilled by this task | ||
| Definition | This element will not be used within the Genomic Medicine Service. The ServiceRequest a Task is seeking to fulfill SHALL be referenced through the | ||
| Cardinality | 0..0 | ||
| Type | Reference(Resource) | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.basedOn.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.basedOn.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.basedOn.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.basedOn.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.basedOn.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.basedOn.identifier.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.basedOn.identifier.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.basedOn.identifier.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.basedOn.identifier.type | |||
| Short | Description of identifier | ||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Summary | True | ||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.basedOn.identifier.system | |||
| Short | The namespace for the identifier value | ||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
| Comments | Identifier.system is always case sensitive. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Task.basedOn.identifier.value | |||
| Short | The value that is unique | ||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Task.basedOn.identifier.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.basedOn.identifier.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| Definition | Organization that issued/manages the identifier. | ||
| Cardinality | 0..1 | ||
| Type | Reference(https://fhir.nhs.uk/StructureDefinition/NHSEngland-Organization-Genomics) | ||
| Summary | True | ||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.basedOn.display | |||
| Short | Text alternative for the resource | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.groupIdentifier | |||
| Short | Requisition or grouper id | ||
| Definition | An identifier that links together multiple tasks and other requests that were created in the same context. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Requirements | Billing and/or reporting can be linked to whether multiple requests were created as a single unit. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.partOf | |||
| Short | Composite task | ||
| Definition | Task that this particular task is part of. | ||
| Cardinality | 0..* | ||
| Type | Reference(NHSEngland_Task_Genomics) | ||
| Summary | True | ||
| Requirements | Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task). | ||
| Comments | This should usually be 0..1. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.partOf.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.partOf.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.partOf.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.partOf.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.partOf.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.partOf.identifier.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.partOf.identifier.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.partOf.identifier.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.partOf.identifier.type | |||
| Short | Description of identifier | ||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Summary | True | ||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.partOf.identifier.system | |||
| Short | The namespace for the identifier value | ||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
| Comments | Identifier.system is always case sensitive. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Task.partOf.identifier.value | |||
| Short | The value that is unique | ||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Task.partOf.identifier.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.partOf.identifier.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| Definition | Organization that issued/manages the identifier. | ||
| Cardinality | 0..1 | ||
| Type | Reference(UKCoreOrganization | https://fhir.nhs.uk/StructureDefinition/NHSEngland-Organization-Genomics) | ||
| Summary | True | ||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.partOf.display | |||
| Short | Text alternative for the resource | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.status | |||
| Short | draft | requested | received | accepted | + | ||
| Definition | Initially, automatically populated by the central service upon instantiation. Tasks will be first marked as 'draft' until their prerequisites have been satisfied, after which they will be marked as 'requested' until accepted/claimed by an organization. Upon acceptance, the owning organization is responsible for updating the status up until completion (or if the owning organization is not integrated into the GMS, the organization who has referred the task to the unintegrated org). If a ServiceRequest is cancelled, any Tasks which have not already moved into in-progress SHALL be moved into the cancelled state, any in-progress Tasks will require lab processes to manage closure of the Task and appropriate reimbursement. For a full list of possible automatic cascading of ServiceRequest.status to Task.status please see additional guidance on the status element on the UKCore-ServiceRequest profile page. It is not expected that Task statuses will propagate up to the ServiceRequest status, though certain task failure types may require revokation of the authorising request (pending investigation). For the full list of expected Task statuses in use by the GMS, please refer to the table below. For the allowed Task status transitions, please see the FHIR R4 Task state machine model. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The current status of the task. | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.statusReason | |||
| Short | Reason for current status | ||
| Definition | Reasons why a Task has been marked as on-hold, cancelled etc. SHOULD use the Genomic-Task-StatusReason CodeSystem. NOTE: The list of appropriate statusReasons is pending finalization. If a code from the linked CodeSystem is not applicable, the code of other SHOULD be used, with a free text reason captured within Task.statusReason.text. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | Codes to identify the reason for current status. These will typically be specific to a particular workflow. https://fhir.nhs.uk/ValueSet/task-statusReason-genomics (preferred) | ||
| Summary | True | ||
| Comments | This applies to the current status. Look at the history of the task to see reasons for past statuses. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.businessStatus | |||
| Short | E.g. "Specimen Received", "Analysis In Progress" | ||
| Definition | Genomic specific business statuses for capturing more granular information as part of processing the task. SHOULD use the Genomic-Business-Status CodeSystem. NOTE: The list of appropriate buinessStatuses is pending finalization. Mapping business statuses to the high level container Tasks and statuses is still ongoing. If a code from the linked CodeSystem is not applicable, the code of other SHOULD be used, with a free text status captured within Task.businessStatus.text. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | The domain-specific business-contextual sub-state of the task. ValueSet specific for Genomics, subject to change. | ||
| Summary | True | ||
| Requirements | There's often a need to track substates of a task - this is often variable by specific workflow implementation. | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.intent | |||
| Short | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option | ||
| Definition | Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | Distinguishes whether the task is a proposal, plan or full order. | ||
| Summary | True | ||
| Comments | This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.priority | |||
| Short | routine | urgent | asap | stat | ||
| Definition | Indicates how quickly the Task should be addressed with respect to other requests. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | The task's priority. | ||
| Requirements | Used to identify the service level expected while performing a task. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Meaning when missing | If missing, this task should be performed with normal priority | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.code | |||
| Short | Task Type | ||
| Definition | High level coding for the Task, matches the NGTP stages for genomic test processing. Clients SHOULD use the Genomic-Task-Code CodeSystem. NOTE: The list of appropriate codes is pending finalization. The currently allowed code list and their definition is provided in the table below. The table also provides the cardinality of each Task per ServiceRequest or Sample attached to the request as generated by the central broker on submission of a test request. Note: the cardinalities listed reflect the number of concurrent active tasks per service request at any one time, there may be cases where additional Tasks need to be spun up manually, e.g. on failure such as when a new sample needs to be processed after a previous sample fails Quality Control, or when further preparation is required. This cardinality supports the use cases for both requests with multiple participants, e.g. Duo/Trio, and multiple samples per participant e.g. Cancer testing. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Codes to identify what the task involves. These will typically be specific to a particular workflow. | ||
| Summary | True | ||
| Comments | The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.description | |||
| Short | Human-readable explanation of task | ||
| Definition | A free-text description of what is to be performed. | ||
| Cardinality | 0..0 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.focus | |||
| Short | What task is acting on | ||
| Definition | The ServiceRequest the Task is fulfilling. Autopopulated by the central service. | ||
| Cardinality | 1..1 | ||
| Type | Reference(NHSEngland_ServiceRequest_Genomics) | ||
| Summary | True | ||
| Requirements | Used to identify the thing to be done. | ||
| Comments | If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.for | |||
| Short | Beneficiary of the Task | ||
| Definition | A reference to the Patient resource or the identifier, NHS number, for the patient for whom the Task is for. Autopopulated by the central service if the Task is automatically generated. If a Task is created by client system or user interaction, for SHALL be populated with a reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS. | ||
| Cardinality | 1..1 | ||
| Type | Reference(Resource | NHSEngland_Patient_Genomics) | ||
| Summary | True | ||
| Alias | Patient | ||
| Requirements | Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.encounter | |||
| Short | Healthcare event during which this task originated | ||
| Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. | ||
| Cardinality | 0..0 | ||
| Type | Reference(Encounter) | ||
| Summary | True | ||
| Requirements | For some tasks it may be important to know the link between the encounter the task originated within. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.executionPeriod | |||
| Short | Start and end time of execution | ||
| Definition | MAY be used to capture start and end DateTimes associated with execution of a Task. It is expected the start time will be populated as a Task is moved to in-progress and the end time will be populated as a Task is marked as completed. Usage of this field will be investigated during the Alpha phase of the Genomic Order Management project as timelines for task execution can also be derived from the AuditEvents recorded as Tasks are updated. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.authoredOn | |||
| Short | Task Creation Date | ||
| Definition | Autopopulated by the central service on creation of the Task. | ||
| Cardinality | 1..1 | ||
| Type | dateTime | ||
| Alias | Created Date | ||
| Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, inv-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.lastModified | |||
| Short | Task Last Modified Date | ||
| Definition | Time at which a change to the task was made, e.g. status updated. SHALL be updated on change. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | ||
| Summary | True | ||
| Alias | Update Date | ||
| Requirements | Used along with history to track task activity and time in a particular task state. This enables monitoring and management. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, inv-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.requester | |||
| Short | Who is asking for task to be done | ||
| Definition | The original requester of the ServiceRequest the Task is fulfilling. Autopopulated by the central service. | ||
| Cardinality | 1..1 | ||
| Type | Reference(NHSEngland_PractitionerRole_Genomics) | ||
| Summary | True | ||
| Requirements | Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task). | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.performerType | |||
| Short | Requested performer | ||
| Definition | The kind of participant that should perform the task. | ||
| Cardinality | 0..0 | ||
| Type | CodeableConcept | ||
| Binding | The type(s) of task performers allowed. | ||
| Requirements | Use to distinguish tasks on different activity queues. | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.owner | |||
| Short | Responsible individual | ||
| Definition | Autopopulated by the central service if a performer is assigned at Test submission. By default, this will the Home GLH for the submitting organization, unless an alternative is specified. The Home GLH/original performer (managing entity) SHOULD remain the owner for the Process Genomic Test Task, throughout the test order-fulfillment process. This field can be updated by the organization claiming the task (though this could also be autopopulated if automated per test routing tables are integrated into the central service functionality). Owner SHOULD be populated using organization ODS code references. The responsibility for routing/reassigning ownership of Tasks lies with the current owner following the transfers of responsibility as per the National Genomic Testing Process (NGTP). The different scenarios for how follow-on routing may be achieved is summarised in the points below: In most cases, by default the test will be routed to the home GLH (or other lab/GLH as dictated by the initial routing table). This would mean all Tasks by default would have this organization, e.g. home GLH, as the initial owner, it would then be the responsibility of the GLH to reassign tasks to other organizations, where they 'send away' or commission work. Once that work is complete, the send-away organization can choose to reassign the current Task (where another organization needs to conduct work against the same Task before it can be marked as complete)/or assign the follow-on Task (where the current task can be marked as complete) to the next organization, if this is known. If the next organization to send work to is unknown, responsibility should lie with the original/previous owner e.g. Home GLH to reassign the task to the next organization that needs to complete work. This should be captured by having the current owner reassign the task back to the GLH (or organization which assigned the task to them) if further work needs to occur within the current task; or the next task in the NGTP moves from the draft state into the requested state (indicating all its prerequisites have been satisfied). The owner of that task, e.g home GLH, then either starts work or assigns this to the relevant organization. In further phases, a routing advice service may be provided by NHS England to aid organizations in identifying which organization should be assigned, after completing their work. Tasks assigned to a particular organization SHOULD be searched for using the owner search parameter with the :identifier modifier i.e. [base]/Task?owner:identifier=8J834 or [base]/Task?owner:identifier=https://fhir.nhs.uk/Id/ods-organization-code|8J834 | ||
| Cardinality | 0..1 | ||
| Type | Reference(UKCoreOrganization) | ||
| Summary | True | ||
| Alias | Performer, Executer | ||
| Requirements | Identifies who is expected to perform this task. | ||
| Comments | Tasks may be created with an owner not yet identified. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.owner.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.owner.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.owner.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||
| Cardinality | 0..0 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.owner.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.owner.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||
| Cardinality | 1..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.owner.identifier.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.owner.identifier.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.owner.identifier.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.owner.identifier.type | |||
| Short | Description of identifier | ||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Summary | True | ||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.owner.identifier.system | |||
| Short | The namespace for the identifier value | ||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
| Comments | Identifier.system is always case sensitive. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | https://fhir.nhs.uk/Id/ods-organisation-code | ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Task.owner.identifier.value | |||
| Short | The value that is unique | ||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Task.owner.identifier.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.owner.identifier.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| Definition | Organization that issued/manages the identifier. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Summary | True | ||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.owner.display | |||
| Short | Text alternative for the resource | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.location | |||
| Short | Where task occurs | ||
| Definition | Principal physical location where the this task is performed. | ||
| Cardinality | 0..0 | ||
| Type | Reference(Location) | ||
| Summary | True | ||
| Requirements | Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.reasonCode | |||
| Short | Why task is needed | ||
| Definition | A description or code indicating why this task needs to be performed. | ||
| Cardinality | 0..0 | ||
| Type | CodeableConcept | ||
| Binding | Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | ||
| Comments | This should only be included if there is no focus or if it differs from the reason indicated on the focus. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.reasonReference | |||
| Short | Why task is needed | ||
| Definition | A resource reference indicating why this task needs to be performed. | ||
| Cardinality | 0..0 | ||
| Type | Reference(Resource) | ||
| Comments | Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.insurance | |||
| Short | Associated insurance coverage | ||
| Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. | ||
| Cardinality | 0..0 | ||
| Type | Reference(ClaimResponse | Coverage) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.note | |||
| Short | Comments made about the task | ||
| Definition | Used for messaging between owner and other orgnizations e.g. during handover of task or requesting information from requesting clinician. | ||
| Cardinality | 0..* | ||
| Type | Annotation | ||
| Comments | 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.relevantHistory | |||
| Short | Key events in history of the Task | ||
| Definition | Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task. | ||
| Cardinality | 0..0 | ||
| Type | Reference(Provenance) | ||
| Alias | Status History | ||
| Comments | This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.restriction | |||
| Short | Constraints on fulfillment tasks | ||
| Definition | If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned. | ||
| Cardinality | 0..0 | ||
| Type | BackboneElement | ||
| Requirements | Sometimes when fulfillment is sought, you don't want full fulfillment. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.restriction.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.restriction.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.restriction.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.restriction.repetitions | |||
| Short | How many times to repeat | ||
| Definition | Indicates the number of times the requested action should occur. | ||
| Cardinality | 0..1 | ||
| Type | positiveInt | ||
| Requirements | E.g. order that requests monthly lab tests, fulfillment is sought for 1. | ||
| Comments | 32 bit number; for values larger than this, use decimal | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.restriction.period | |||
| Short | When fulfillment sought | ||
| Definition | Over what time-period is fulfillment sought. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Requirements | E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months. | ||
| Comments | Note that period.high is the due date representing the time by which the task should be completed. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.restriction.recipient | |||
| Short | For whom is fulfillment sought? | ||
| Definition | For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought? | ||
| Cardinality | 0..* | ||
| Type | Reference(Group | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.input | |||
| Short | Information used to perform task | ||
| Definition | Used to attach inputs to a Task, if relevant. e.g. references to Specimen's which a Sample Processing task is acting on. No CodeSystem exists for this field as of publication but this will be investigated as future work. Specimen references SHOULD be added to Tasks acting on Specimen resources, e.g. Tasks marked SamplePreparation or SampleProcessing. This is to clearly disambiguate which specimen a task is acting on, where multiple specimens are necessary for processing the test request. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Alias | Supporting Information | ||
| Requirements | Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.input.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.input.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.input.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.input.type | |||
| Short | Label for the input | ||
| Definition | A code or description indicating how the input is intended to be used as part of the task execution. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc. https://fhir.nhs.uk/ValueSet/AdditionalInfoTypeGenomics (preferred) | ||
| Alias | Name | ||
| Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next. | ||
| Comments | If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.input.value[x] | |||
| Short | Content to use in performing the task | ||
| Definition | The value of the input parameter as a basic type. | ||
| Cardinality | 1..1 | ||
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.output | |||
| Short | Information produced as part of task | ||
| Definition | Used to attach outputs from a Task, if relevant. e.g. VUS files during processing or a DiagnosticReport upon completion of reporting stage. No CodeSystem exists for this field as of publication but this will be investigated as future work. Sample tracking information SHOULD be added to Tasks acting on Specimen resources, e.g. Tasks marked SamplePreparation or SampleProcessing, on either the output or input elements. This information MAY include consignment number, destination, date sent etc. Further modelling of the types/format expected are pending clinical scenarios. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Requirements | Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.output.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.output.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.output.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.output.type | |||
| Short | Label for output | ||
| Definition | The name of the Output parameter. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc. https://fhir.nhs.uk/ValueSet/AdditionalInfoTypeGenomics (preferred) | ||
| Alias | Name | ||
| Requirements | Outputs are named to enable task automation to bind data and pass it from one task to the next. | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.output.value[x] | |||
| Short | Result of output | ||
| Definition | The value of the Output parameter as a basic type. | ||
| Cardinality | 1..1 | ||
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid | ||
| Requirements | Task outputs can take any form. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
Table View
| Task | 0..* | |
| Task.id | id | 0..1 |
| Task.meta | Meta | 0..1 |
| Task.implicitRules | uri | 0..1 |
| Task.language | code | 0..1 |
| Task.text | Narrative | 0..1 |
| Task.contained | Resource | 0..* |
| Task.extension | Extension | 0..* |
| Task.modifierExtension | Extension | 0..* |
| Task.identifier | Identifier | 0..* |
| Task.instantiatesCanonical | canonical(ActivityDefinition) | 0..1 |
| Task.instantiatesUri | uri | 0..1 |
| Task.basedOn | Reference(Resource) | 0..0 |
| Task.basedOn.id | string | 0..1 |
| Task.basedOn.extension | Extension | 0..* |
| Task.basedOn.reference | string | 0..1 |
| Task.basedOn.type | uri | 0..1 |
| Task.basedOn.identifier | Identifier | 0..1 |
| Task.basedOn.identifier.id | string | 0..1 |
| Task.basedOn.identifier.extension | Extension | 0..* |
| Task.basedOn.identifier.use | code | 0..1 |
| Task.basedOn.identifier.type | CodeableConcept | 0..1 |
| Task.basedOn.identifier.system | uri | 0..1 |
| Task.basedOn.identifier.value | string | 0..1 |
| Task.basedOn.identifier.period | Period | 0..1 |
| Task.basedOn.identifier.assigner | Reference(https://fhir.nhs.uk/StructureDefinition/NHSEngland-Organization-Genomics) | 0..1 |
| Task.basedOn.display | string | 0..1 |
| Task.groupIdentifier | Identifier | 0..1 |
| Task.partOf | Reference(NHSEngland_Task_Genomics) | 0..* |
| Task.partOf.id | string | 0..1 |
| Task.partOf.extension | Extension | 0..* |
| Task.partOf.reference | string | 0..1 |
| Task.partOf.type | uri | 0..1 |
| Task.partOf.identifier | Identifier | 0..1 |
| Task.partOf.identifier.id | string | 0..1 |
| Task.partOf.identifier.extension | Extension | 0..* |
| Task.partOf.identifier.use | code | 0..1 |
| Task.partOf.identifier.type | CodeableConcept | 0..1 |
| Task.partOf.identifier.system | uri | 0..1 |
| Task.partOf.identifier.value | string | 0..1 |
| Task.partOf.identifier.period | Period | 0..1 |
| Task.partOf.identifier.assigner | Reference(UKCoreOrganization | https://fhir.nhs.uk/StructureDefinition/NHSEngland-Organization-Genomics) | 0..1 |
| Task.partOf.display | string | 0..1 |
| Task.status | code | 1..1 |
| Task.statusReason | CodeableConcept | 0..1 |
| Task.businessStatus | CodeableConcept | 0..1 |
| Task.intent | code | 1..1 |
| Task.priority | code | 0..1 |
| Task.code | CodeableConcept | 1..1 |
| Task.description | string | 0..0 |
| Task.focus | Reference(NHSEngland_ServiceRequest_Genomics) | 1..1 |
| Task.for | Reference(Resource | NHSEngland_Patient_Genomics) | 1..1 |
| Task.encounter | Reference(Encounter) | 0..0 |
| Task.executionPeriod | Period | 0..1 |
| Task.authoredOn | dateTime | 1..1 |
| Task.lastModified | dateTime | 0..1 |
| Task.requester | Reference(NHSEngland_PractitionerRole_Genomics) | 1..1 |
| Task.performerType | CodeableConcept | 0..0 |
| Task.owner | Reference(UKCoreOrganization) | 0..1 |
| Task.owner.id | string | 0..1 |
| Task.owner.extension | Extension | 0..* |
| Task.owner.reference | string | 0..0 |
| Task.owner.type | uri | 0..1 |
| Task.owner.identifier | Identifier | 1..1 |
| Task.owner.identifier.id | string | 0..1 |
| Task.owner.identifier.extension | Extension | 0..* |
| Task.owner.identifier.use | code | 0..1 |
| Task.owner.identifier.type | CodeableConcept | 0..1 |
| Task.owner.identifier.system | uri | 0..1 |
| Task.owner.identifier.value | string | 0..1 |
| Task.owner.identifier.period | Period | 0..1 |
| Task.owner.identifier.assigner | Reference(Organization) | 0..1 |
| Task.owner.display | string | 0..1 |
| Task.location | Reference(Location) | 0..0 |
| Task.reasonCode | CodeableConcept | 0..0 |
| Task.reasonReference | Reference(Resource) | 0..0 |
| Task.insurance | Reference(ClaimResponse | Coverage) | 0..0 |
| Task.note | Annotation | 0..* |
| Task.relevantHistory | Reference(Provenance) | 0..0 |
| Task.restriction | BackboneElement | 0..0 |
| Task.restriction.id | string | 0..1 |
| Task.restriction.extension | Extension | 0..* |
| Task.restriction.modifierExtension | Extension | 0..* |
| Task.restriction.repetitions | positiveInt | 0..1 |
| Task.restriction.period | Period | 0..1 |
| Task.restriction.recipient | Reference(Group | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 0..* |
| Task.input | BackboneElement | 0..* |
| Task.input.id | string | 0..1 |
| Task.input.extension | Extension | 0..* |
| Task.input.modifierExtension | Extension | 0..* |
| Task.input.type | CodeableConcept | 1..1 |
| Task.input.value[x] | Address | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid | 1..1 |
| Task.output | BackboneElement | 0..* |
| Task.output.id | string | 0..1 |
| Task.output.extension | Extension | 0..* |
| Task.output.modifierExtension | Extension | 0..* |
| Task.output.type | CodeableConcept | 1..1 |
| Task.output.value[x] | Address | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid | 1..1 |
XML View
JSON View
| FHIR | MDS | HL7v2 |
|---|---|---|
| Task.executionPeriod.start | PLCM activity - Activity start date and time | Derived from TQ1-7 in the ORL response message for the activity based on the OML request |
| Task.executionPeriod.end | PLCM activity - Activity end date and time | Derived from TQ1-8 in the ORL response message for the activity based on the OML request |
| Task.owner | PLCM activity - ODS code of organisation submitting to PLCM, PLCM activity - ODS code of organisation delivering requested test, PLCM activity - ODS code of the laboratory site delivering requested test | OBR-32.7 if sourced from principle results interpreter, OBX-32.10, AFF-2.10 associated with performing organization |
| Task.status | PLCM activity - Sample plating quality control | Implied through status recorded in ORC-25 indicating plating quality control had passed |
| Task.statusReason | PLCM activity - Sample plating quality control fail code | ORC-25 |
| Task.output | Extracted specimen - Location details | SAC-15 |
Additional Guidance
- basedOn
- status
- statusReason
- businessStatus
- code
- focus
- for
- executionPeriod
- authoredOn
- lastModified
- requester
- owner
- note
- input
- output
basedOn
This element will not be used within the Genomic Medicine Service. The ServiceRequest a Task is seeking to fulfill SHALL be referenced through the `focus` element. Specimen resources being acted upon by tasks related to specimen prep/processing SHOULD be referenced through the `Task.input` element.status
Initially, automatically populated by the central service upon instantiation. Tasks will be first marked as 'draft' until their prerequisites have been satisfied, after which they will be marked as 'requested' until accepted/claimed by an organization. Upon acceptance, the owning organization is responsible for updating the status up until completion (or if the owning organization is not integrated into the GMS, the organization who has referred the task to the unintegrated org).If a ServiceRequest is cancelled, any Tasks which have not already moved into in-progress SHALL be moved into the cancelled state, any in-progress Tasks will require lab processes to manage closure of the Task and appropriate reimbursement. For a full list of possible automatic cascading of ServiceRequest.status to Task.status please see additional guidance on the status element on the Genomics-ServiceRequest profile page.
It is not expected that Task statuses will propagate up to the ServiceRequest status, though certain task failure types may require revokation of the authorising request (pending investigation).
For the full list of expected Task statuses in use by the GMS, please refer to the table below. For the allowed Task status transitions, please see the FHIR R4 Task state machine model.
| Status | Description | Genomic workflow usage |
|---|---|---|
| Draft | The task is not yet ready to be acted upon. | Initial state for Tasks. Used for tasks which require prerequisite tasks to be completed first. |
| Requested | The task is ready to be acted upon and action is sought. | Status indicating a task can be worked on/claimed, all prerequisites have been satisfied. |
| Received | A potential performer has claimed ownership of the task and is evaluating whether to perform it. | NOT USED within Genomics as Tasks will be polled for rather than being sent out to assigned organizations. Most likely not used unless tasks are automatically assigned and organizations are notified by the central service, e.g. to GLH. |
| Accepted | The potential performer has agreed to execute the task but has not yet started work. | Used when an assigned owner has accepted the task after being assigned. |
| Rejected | The potential performer who claimed ownership of the task has decided not to execute it prior to performing any action. | Used if an organization was assigned to a task but is unable to perform work against it. It is expected if an alternative organization can be assigned, this is done as an owner update rather than marking the task as rejected. If subsequent work does occur, a duplicate task will need to be created as the 'rejected' state is a terminal one. |
| Ready | The task is ready to be performed, but no action has yet been taken. Used in place of requested/received/accepted/rejected when request assignment and acceptance is a given. | NOT USED within Genomics as it is not assumed that Tasks will be automatically accepted when prerequisites are satisfied. |
| Cancelled | The task was not completed. | Used when a task has been created but later identified as unneeded, e.g. due to modifications to test order such as the ServiceRequest being cancelled. Automatically set by the central broker. |
| In Progress | The task has been started but is not yet complete. | When work has commenced. |
| On Hold | The task has been started but work has been paused. | A holding state where work is expected to continue but is being blocked through some external issue. Suppliers will need to state reason why work is on hold through the statusReason field e.g. Awaiting Sample. |
| Failed | The task was attempted but could not be completed due to some error. | Indicates the task cannot continue and is unrcoverable without external intervention. If modifications to the test order allow the task to be resumed, a new task should be created e.g. a new sample is provided to replace a previous sample which has failed quality control. If the Task results in an unrecoverable error, the ServiceRequest may need to be revoked. |
| Completed | The task has been completed. | Marked once all actions against a task are complete, and follow on Tasks can commence. |
| Entered in Error | The task should never have existed and is retained only because of the possibility it may have used. | May be used if user created Tasks are created in error, e.g. duplicate Tasks, or Tasks have been created by the central broker and the ServiceRequest has subsequently been marked as entered-in-error. |
"status": "rejected",
statusReason
Reasons why a Task has been marked as on-hold, cancelled etc. SHOULD use the Genomic-Task-StatusReason CodeSystem. NOTE: The list of appropriate statusReasons is pending finalization.If a code from the linked CodeSystem is not applicable, the code of other SHOULD be used, with a free text reason captured within Task.statusReason.text.
"statusReason": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/task-status-reason-genomics", "code": "further-information-needed", "display": "Further Information Needed" } ] },
businessStatus
Genomic specific business statuses for capturing more granular information as part of processing the task. SHOULD use the Genomic-Business-Status CodeSystem. NOTE: The list of appropriate buinessStatuses is pending finalization. Mapping business statuses to the high level container Tasks and statuses is still ongoing.If a code from the linked CodeSystem is not applicable, the code of other SHOULD be used, with a free text status captured within Task.businessStatus.text.
"businessStatus": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/business-status-genomics", "code": "sample-sent", "display": "Sample Sent" } ] },
code
High level coding for the Task, matches the NGTP stages for genomic test processing. Clients SHOULD use the Genomic-Task-Code CodeSystem. NOTE: The list of appropriate codes is pending finalization.The currently allowed code list and their definition is provided in the table below. The table also provides the cardinality of each Task per ServiceRequest or Sample attached to the request as generated by the central broker on submission of a test request. Note: the cardinalities listed reflect the number of concurrent active tasks per service request at any one time, there may be cases where additional Tasks need to be spun up manually, e.g. on failure such as when a new sample needs to be processed after a previous sample fails Quality Control, or when further preparation is required. This cardinality supports the use cases for both requests with multiple participants, e.g. Duo/Trio, and multiple samples per participant e.g. Cancer testing.
| Task.code display | Definition of work within Task | Cardinality (general case) | Cardinality (Reanalysis/Reinterpretation) | Cardinality (DNA Storage) |
|---|---|---|---|---|
| Process Genomic Test Request | Test code requested is ratified by the lab against provided patient information (checking eligibility) | 1..1 (per ServiceRequest) | 1..1 | 1..1 |
| Request & Sample Alignment | The lab confirms/validates the data and sample(s) required for given test type are present | 1..* (1 per Specimen referenced from or referencing the ServiceRequest) | 1..1 (At least 1 will always be required, e.g. for validation of data in the No Sample scenario) | 1..* (per Sample) |
| Sample Preparation | Sample is prepared, as appropriate for the selected test type, and DNA extracted. May have multiples if further preparation is required | 1..* (1 per Sample) | 0..0 (Not required for Reanalysis/Reinterpretation requests where a sample does not need to be prepared) | 1..* (1 per Sample) |
| Sample Processing | DNA sample(s) are sequenced, generating read/sequence data to feed into analysis | 1..* (1 per Sample or extracted DNA sample) | 0..0 (Not required for Reanalysis/Reinterpretation requests where a sample does not need to be sequenced) | 0..0 (Not required for DNA storage where a sample does not need to be sequenced) |
| Genetic/Genomic Data Processing | Sequence data is passed through a bio-pipeline, generates variant priorities lists for analysis | 1..* (1 per Sample or read data) | 0..* (For Reanalysis, should match the number of Samples for the parent request. Not required for Reinterpretation requests) | 0..0 (Not required for DNA storage requests) |
| Interpretation | Results analysis is organised and interpreted by a Clincial Scientist | 1..* (1 per Sample or variant priorities list) | 1..* (For Reanalysis/Reinterpretation, should match the number of Samples for the parent request | 0..0 (Not required for DNA storage requests) |
| Produce Interim Report | A report is created and deemed interim pending MDT, if necessary | 1..* (1 per Sample. TBC whether one interim report would be generated per sample/set of genetic data or 1 per request) | 1..* (For Reanalysis/Reinterpretation, should match the number of Samples for the parent request | 0..0 (Not required for DNA storage requests) |
| Genomic MDT | Multi-Diciplinary-Team consults on the interim report | 1..1 (max 1 per ServiceRequest, for the purposes of the Alpha an MDT task will always be created, even if not needed) | 1..1 | 0..0 (Not required for DNA storage requests) |
| Produce Final Report | Interim report is deemed final or is updated following MDT | 1..1 (per ServiceRequest) | 1..1 | 1..1 |
| Distribute Report | Final report is distributed or marked as distributable/available | 1..1 (per ServiceRequest or Final Report) | 1..1 | 1..1 |
Rendered within a diagram, the Task cardinalities and their inputs are illustrated in the diagram below:
"code": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/task-code-genomics", "code": "sample-processing", "display": "Sample Processing" } ] },
focus
The ServiceRequest the Task is fulfilling. Autopopulated by the central service."focus": { "reference": "ServiceRequest/ServiceRequest-SavedTestOrder-Example" },
for
A reference to the Patient resource or the identifier, NHS number, for the patient for whom the Task is for. Autopopulated by the central service if the Task is automatically generated.If a Task is created by client system or user interaction, for SHALL be populated with a reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS.
"for": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
executionPeriod
MAY be used to capture start and end DateTimes associated with execution of a Task. It is expected the start time will be populated as a Task is moved to in-progress and the end time will be populated as a Task is marked as completed. Usage of this field will be investigated during the Alpha phase of the Genomic Order Management project as timelines for task execution can also be derived from the AuditEvents recorded as Tasks are updated."executionPeriod": { "start": "2023-10-31T10:25:05+00:00", "end": "2023-11-15T16:45:05+00:00" },
authoredOn
Autopopulated by the central service on creation of the Task."authoredOn": "2023-09-18T18:30:00Z"
lastModidified
Time at which a change to the task was made, e.g. status updated. SHALL be updated on change."lastModified": "2023-09-18T19:11:00Z"
requester
The original requester of the ServiceRequest the Task is fulfilling. Autopopulated by the central service."requester": { "reference": "PractitionerRole/PractitionerRole-GeneSmithENT-Example" },
owner
Autopopulated by the central service if a performer is assigned at Test submission. By default, this will the Home GLH for the submitting organization, unless an alternative is specified. The Home GLH/original performer (managing entity) SHOULD remain the owner for the Process Genomic Test Task, throughout the test order-fulfillment process.This field can be updated by the organization claiming the task (though this could also be autopopulated if automated per test routing tables are integrated into the central service functionality). Owner SHOULD be populated using organization ODS code references.
The responsibility for routing/reassigning ownership of Tasks lies with the current owner following the transfers of responsibility as per the National Genomic Testing Process (NGTP). The different scenarios for how follow-on routing may be achieved is summarised in the points below:
- In most cases, by default the test will be routed to the home GLH (or other lab/GLH as dictated by the initial routing table).
- This would mean all Tasks by default would have this organization, e.g. home GLH, as the initial owner, it would then be the responsibility of the GLH to reassign tasks to other organizations, where they 'send away' or commission work.
- Once that work is complete, the send-away organization can choose to reassign the current Task (where another organization needs to conduct work against the same Task before it can be marked as complete)/or assign the follow-on Task (where the current task can be marked as complete) to the next organization, if this is known.
- If the next organization to send work to is unknown, responsibility should lie with the original/previous owner e.g. Home GLH to reassign the task to the next organization that needs to complete work. This should be captured by having the current owner reassign the task back to the GLH (or organization which assigned the task to them) if further work needs to occur within the current task; or the next task in the NGTP moves from the draft state into the requested state (indicating all its prerequisites have been satisfied). The owner of that task, e.g home GLH, then either starts work or assigns this to the relevant organization.
- In further phases, a routing advice service may be provided by NHS England to aid organizations in identifying which organization should be assigned, after completing their work.
Tasks assigned to a particular organization SHOULD be searched for using the owner search parameter with the :identifier modifier i.e. [base]/Task?owner:identifier=8J834 or [base]/Task?owner:identifier=https://fhir.nhs.uk/Id/ods-organization-code|8J834
"owner": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "69010" }, "display": "Pathology Lab - ADDENBROOKE'S HOSPITAL LABORATORY" },
note
Used for messaging between owner and other orgnizations e.g. during handover of task or requesting information from requesting clinician."note": [ { "text": "Sample has not been received within 4 week window. Task will be closed unless further communication is received" } ]
input
Used to attach inputs to a Task, if relevant. e.g. references to Specimen's which a Sample Processing task is acting on. No CodeSystem exists for this field as of publication but this will be investigated as future work.Specimen references SHOULD be added to Tasks acting on Specimen resources, e.g. Tasks marked SamplePreparation or SampleProcessing. This is to clearly disambiguate which specimen a task is acting on, where multiple specimens are necessary for processing the test request.
The table below provides possible inputs that could be provided for certain Tasks as part of fulfillment of a test order. A finalised list is pending business analysis work to identify the operational data generated as fulfilment against a test order progresses and the need for this data to pass between organizations.
| Task.code display | Possible Task.input |
|---|---|
| Process Genomic Test Request | N/A, all information required should be part of or refernced from the ServiceRequest |
| Request & Sample Alignment | Specimen resource to be aligned and potentially Consent resources where these are captured post submission of a test request |
| Sample Preparation | Specimen resource to be prepared as part of this Task |
| Sample Processing | DNA Specimen resource to be sequenced as part of this Task as well as Consignment, Rack and Well identifiers to allow for specimen tracking |
| Genetic/Genomic Data Processing | Sequence data generated from the previous Task, potentially referenced using DocumentReference resources, these SHOULD reference the Specimen from which the data originated |
| Interpretation | Variant Priorities lists generated from the previous Task, the representation of these lists is still under investigation |
| Produce Interim Report | Guidance/Recommendations generated though data interpretation, the representation of these items is still under investigation |
| Genomic MDT | Interim reports, references to Diagnostic report resources containing either structured Genomic reports or binary representations of the reports |
| Produce Final Report | Interim reports and potentially recommendations from the MDT, whether these are represented within the DiagnosticReport itself or contained as other resource types is still under investigation |
| Distribute Report | The final report to be distributed |
"input": [ { "type": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/AdditionalInfoTypeGenomics", "code": "Specimen", "display": "Specimen" } ] }, "valueReference": { "reference": "Specimen/Specimen-CancerSolidTumor-Example" } } ]
output
Used to attach outputs from a Task, if relevant. e.g. VUS files during processing or a DiagnosticReport upon completion of reporting stage. No CodeSystem exists for this field as of publication but this will be investigated as future work.Sample tracking information SHOULD be added to Tasks acting on Specimen resources, e.g. Tasks marked SamplePreparation or SampleProcessing, on either the output or input elements. This information MAY include consignment number, destination, date sent etc. Further modelling of the types/format expected are pending clinical scenarios.
The table below provides possible outputs that could be generated by certain Tasks as part of fulfillment of a test order. A finalised list is pending business analysis work to identify the operational data generated as fulfilment against a test order progresses and the need for this data to pass between organizations.
| Task.code display | Possible Task.output |
|---|---|
| Process Genomic Test Request | N/A, may result in updates to the ServiceRequest if codes or supporting information needs to change |
| Request & Sample Alignment | Aligned Specimen resource for request (except for Reanalysis/Reinterpretation) |
| Sample Preparation | DNA Specimen resource as well as Consignment, Rack and Well identifiers to allow for specimen tracking |
| Sample Processing | Sequence/Read data |
| Genetic/Genomic Data Processing | Variant information |
| Interpretation | Potentially structured guidance/recommendations |
| Produce Interim Report | Interim reports |
| Genomic MDT | Potentially ammended Interim/combined report or recommendations from MDT |
| Produce Final Report | Final Report |
| Distribute Report | N/A, final report will be included as input to Task |
"output": [ { "type": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/AdditionalInfoTypeGenomics", "code": "DiagnosticReport", "display": "DiagnosticReport" } ] }, "valueReference": { "reference": "DiagnosticReport/DiagnosticReport-PhoebeSmithGeneticReport-Example" } } ]