National Pathology FHIR Message Profiles
Test Request Summary Overview for a Haemotology or Chemical Biology Test
Information from the original request that is returned with the test report. This has two purposes.
- 1.) To assist in linking the report to the original request;
- 2.) Give context to the test report where the receiving HCP is different to the requesting HCP and does not have access to the original request.
Mapping for Procedure Request
The test request summary is used to capture the details about the test that has been requested by a healthcare organisation
How to populate the Procedure Request instance to conform to the profiles below:
Level 1 | ProcedureRequest Resource | Level 2 | CareConnect-ProcedureRequest-1 | Level 3 | None |
View Used FHIR Elements | View All FHIR Elements |
Name | Card. | Conformance | Type | Description, Constraints and mapping for National Pathology Implementation |
---|---|---|---|---|
ProcedureRequest | | A request for a procedure or diagnostic to be performed Constraint (dom-2): If the resource is contained in another resource, it SHALL NOT contain nested Resources Constraint (dom-1): If the resource is contained in another resource, it SHALL NOT contain any narrative Constraint (dom-4): If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated Constraint (dom-3): If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
||
- id | 0..1 | Mandatory | Id | Logical id of this artifact |
- meta | 0..1 | Mandatory | Meta | Metadata about the resource |
- implicitRules | 0..1 | Not Used | Uri | A set of rules under which this content was created |
- language | 0..1 | Not Used | Code | Language of the resource content Binding (extensible): A human language. Common Languages |
- text | 0..1 | Not Used | Narrative | Text summary of the resource, for human interpretation |
- contained | 0..* | Not Used | Resource | Contained, inline Resources |
- modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both Slicing: Description: Extensions are always sliced by (at least) url, Discriminator: url, Ordering: false, Rules: Open |
- identifier | 1..1 | Mandatory | Identifier | Identifiers assigned to this order |
- - use | 0..1 | Not Used | Code | usual : official : temp : secondary (If known) Binding (required): Identifies the purpose for this identifier, if known. IdentifierUse |
- - type | 0..1 | Not Used | CodeableConcept | Description of identifier Binding (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes |
- - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
- - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
- - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
- - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
- - - - display | 0..1 | Not Used | String | Representation defined by the system |
- - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
- - - text | 0..1 | Not Used | String | Plain text representation of the concept |
- - system | 0..1 | Not Used | Uri | The namespace for the identifier value |
- - value | 0..1 | Not Used | String | The value that is unique |
- - period | 0..1 | Not Used | Period | Time period when id is/was valid for use Constraint (per-1): If present, start SHALL have a lower value than end |
- - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
- - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
- - assigner | 0..1 | Not Used | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Not Used | Organization | |||
- - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - - display | 0..1 | Not Used | String | Text alternative for the resource |
- definition | 0..* | Not Used | Reference | Protocol or definition Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Not Used | ActivityDefinition | |||
Not Used | PlanDefinition | |||
- - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - display | 0..1 | Not Used | String | Text alternative for the resource |
- basedOn | 0..* | Not Used | Reference | What request fulfills Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Not Used | Resource | |||
- - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - display | 0..1 | Not Used | String | Text alternative for the resource |
- - replaces | 0..* | Not Used | Reference | What request replaces Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Not Used | Resource | |||
- - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - display | 0..1 | Not Used | String | Text alternative for the resource |
- requisition | 0..1 | Not Used | Identifier | Composite Request ID |
- - use | 0..1 | Not Used | Code | usual : official : temp : secondary (If known) Binding (required): Identifies the purpose for this identifier, if known. IdentifierUse |
- - type | 0..1 | Not Used | CodeableConcept | Description of identifier Binding (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes |
- - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
- - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
- - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
- - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
- - - - display | 0..1 | Not Used | String | Representation defined by the system |
- - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
- - - text | 0..1 | Not Used | String | Plain text representation of the concept |
- - system | 0..1 | Not Used | Uri | The namespace for the identifier value |
- - value | 0..1 | Not Used | String | The value that is unique |
- - period | 0..1 | Not Used | Period | Time period when id is/was valid for use Constraint (per-1): If present, start SHALL have a lower value than end |
- - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
- - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
- - assigner | 0..1 | Not Used | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Not Used | Organization | |||
- - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - - display | 0..1 | Not Used | String | Text alternative for the resource |
- status | 1..1 | Mandatory | Code | draft : active : suspended : completed : entered-in-error : cancelled Binding (required): The status of a procedure or diagnostic order. RequestStatus MUST use Active |
- intent | 1..1 | Not Used | Code | |
- priority | 0..1 | Not Used | Code | routine : urgent : asap : stat Binding (required): Identifies the level of importance to be assigned to actioning the request RequestPriority |
- doNotPerform | 0..1 | Not Used | Boolean | True if procedure should not be performed Default Value: false |
- category | 0..* | Not Used | CodeableConcept | Classification of procedure Binding (example): Classification of the procedure Procedure Category Codes (SNOMED CT) |
- - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
- - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
- - - version | 0..1 | Not Used | String | Version of the system - if relevant |
- - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
- - - display | 0..1 | Not Used | String | Representation defined by the system |
- - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
- - text | 0..1 | Not Used | String | Plain text representation of the concept |
- code | 1..1 | Required | CodeableConcept | What is being requested/ordered Binding (example): Codes for tests/services that can be performed by procedure or diagnostic services. For laboratory, LOINC is (preferred)[http://hl7.org/fhir/STU3/terminologies.html#preferred] and a valueset using LOINC Order codes is available here. Procedure Codes (SNOMED CT) Requested Tests |
- - coding | 0..* | Optional | Coding | Code defined by a terminology system |
- - - system | 1..1 | Mandatory | Uri | Identity of the terminology system |
- - - version | 0..1 | Not Used | String | Version of the system - if relevant |
- - - code | 1..1 | Mandatory | Code | Symbol in syntax defined by the system |
- - - display | 1..1 | Mandatory | String | Representation defined by the system |
- - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
- - text | 0..1 | Optional | String | Plain text representation of the concept |
- subject | 1..1 | Mandatory | Reference | Individual the service is ordered for Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Mandatory | CareConnect-Patient-1 | The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-ProcedueRequest-1' | ||
Not Used | Group | |||
Not Used | Location | |||
Not Used | Device | |||
- - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - display | 0..1 | Not Used | String | Text alternative for the resource |
- context | 0..1 | Not Used | Reference | Encounter or Episode during which request was created Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Not Used | Encounter | |||
Not Used | EpisodeOfCare | |||
- - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - display | 0..1 | Not Used | String | Text alternative for the resource |
- occurrence[x] | 0..1 | Not Used | dateTime | When procedure should occur |
Not Used | Period | |||
Not Used | Timing | |||
- asNeeded[x] | 0..1 | Not Used | Boolean | Preconditions for procedure or diagnostic Binding (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example “pain”, “on flare-up”, etc. SNOMED CT Medication As Needed Reason Codes |
Not Used | CodeableConcept | |||
- authoredOn | 0..1 | Not Used | dateTime | Date request signed |
- requester | 0..1 | Mandatory | BackboneElement | Who/what is requesting procedure or diagnostic |
- - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
- - agent | 1..1 | Mandatory | Reference | Individual making the request Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Not Used | Device | |||
Mandatory | CareConnect-Practitioner-1 | The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-Practitioner-1' Requesting HCP |
||
Mandatory | CareConnect-Organization-1 | The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-Organization-1' Requesting Organisation |
||
- - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - - display | 0..1 | Not Used | String | Text alternative for the resource |
- - onBehalfOf | 0..1 | Not Used | Reference | Organization agent is acting for Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Not Used | Organization | |||
- - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - - display | 0..1 | Not Used | String | Text alternative for the resource |
- performerType | 0..1 | Not Used | CodeableConcept | Performer role Binding (example): Indicates specific responsibility of an individual within the care team, such as “Primary physician”, “Team coordinator”, “Caregiver”, etc. Participant Roles |
- - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
- - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
- - - version | 0..1 | Not Used | String | Version of the system - if relevant |
- - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
- - - display | 0..1 | Not Used | String | Representation defined by the system |
- - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
- - text | 0..1 | Not Used | String | Plain text representation of the concept |
- performer | 0..1 | Mandatory | Reference | Requested perfomer Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Mandatory | CareConnect-Practitioner-1 | The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-Practitioner-1' Performing HCP |
||
Not Used | CareConnect-Organization-1 | The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-Organization-1' Performing Organisation |
||
Not Used | Patient | |||
Not Used | Device | |||
Not Used | RelatedPerson | |||
Not Used | HealthcareService | |||
- - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - display | 0..1 | Not Used | String | Text alternative for the resource |
- reasonCode | 0..* | Required | CodeableConcept | Explanation/Justification for test Binding (example): Diagnosis or problem codes justifying the reason for requesting the procedure or diagnostic investigation. Procedure Reason Codes Request Raseon Code |
- - coding | 0..* | Optional | Coding | Code defined by a terminology system |
- - - system | 1..1 | Mandatory | Uri | Identity of the terminology system |
- - - version | 0..1 | Not Used | String | Version of the system - if relevant |
- - - code | 1..1 | Mandatory | Code | Symbol in syntax defined by the system |
- - - display | 1..1 | Mandatory | String | Representation defined by the system |
- - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
- - text | 0..1 | Required | String | Plain text representation of the concept Request Information Text |
- reasonReference | 0..* | Required | Reference | Explanation/Justification for test Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Required | CareConnect-Condition-1 | ***Need to agree a description for this element. - Condition code*** |
||
Required | CareConnect-Observation-1 | |||
- - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - display | 0..1 | Not Used | String | Text alternative for the resource |
- supportingInfo | 0..* | Required | Reference | Additional clinical information Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Required | CareConnect-Observation-1 | <font color-“red”>A set of pre-requisite information prior to the test taking place. This may be coded or human readable inforamtion</font> | ||
- - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - display | 0..1 | Not Used | String | Text alternative for the resource |
- specimen | 0..* | Not Used | Reference | Procedure Samples Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Not Used | Specimen | |||
- - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - display | 0..1 | Not Used | String | Text alternative for the resource |
- bodySite | 0..* | Not Used | CodeableConcept | Location on Body Binding (example): Codes describing anatomical locations. May include laterality. SNOMED CT Body Structures |
- - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
- - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
- - - version | 0..1 | Not Used | String | Version of the system - if relevant |
- - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
- - - display | 0..1 | Not Used | String | Representation defined by the system |
- - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
- - text | 0..1 | Not Used | String | Plain text representation of the concept |
- note | 0..* | Not Used | Annotation | Comments |
- - author[x] | 0..1 | Not Used | Reference | Individual responsible for the annotation Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Not Used | Practitioner | |||
Not Used | Patient | |||
Not Used | RelatedPerson | |||
Not Used | String | |||
- - time | 0..1 | Not Used | dateTime | When the annotation was made |
- - text | 1..1 | Not Used | String | The annotation - text content |
- relevantHistory | 0..* | Not Used | Reference | Request provenance Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
Not Used | Provenance | |||
- - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
- - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
- - display | 0..1 | Not Used | String | Text alternative for the resource |