Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Test Overview

These pages assist with requirements gathering and mapping stages of an ITK3 Messaging Solution development process.

Mapping table

View Used Elements Only

Level 1 Procedure Resource
Level 2 CareConnect-Procedure-1
Level 3 CareConnect-NHSD-Procedure-1
Procedure - Profiled using CareConnect-NHSD-Procedure-1        
Elemernt Name Card. Conformance Type Mapping Constraints For This Implemenation
Procedure     An action that is being or was performed on a patient
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
Constraint (pro-1): Reason not done is only permitted if notDone indicator is true
- Procedure.id 0..1 Not Used Id  
- meta 0..1 Mandatory Meta Profile element MUST conrtain the value
https://fhir.nhs.uk/StructureDefinition/CareConnect-NHSD-Procedure-1
- implicitRules 0..1 Not Used Uri  
- language 0..1 Not Used Code  
- text 0..1 Not Used Narrative  
- contained 0..* Not Used Resource  
- extension (anaestheticIssues) 0..1 Required Extension Details of any adverse reaction to any anaesthetic agents. Constraint (ext-1): Must have either extensions or value[x], not both. See extension mapping table for more information. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AnaestheticIssues-1
- modifierExtension 0..* Not Used Extension  
- identifier 0..* Mandatory Identifier External Identifiers for this procedure
- - use 0..1 Not Used Code  
- - type 0..1 Not Used CodeableConcept  
- - - coding 0..* Not Used Coding  
- - - - system 0..1 Not Used Uri  
- - - - version 0..1 Not Used String  
- - - - code 0..1 Not Used Code  
- - - - display 0..1 Not Used String  
- - - - userSelected 0..1 Not Used Boolean  
- - - text 0..1 Not Used String  
- - system 1..1 Mandatory Uri The namespace for the identifier value - MUST contain the URI https://tools.ietf.org/html/rfc4122
- - value 1..1 Mandatory String The value that is unique - MUST contain a UUID
- - period 0..1 Not Used Period  
- - - start 0..1 Not Used dateTime  
- - - end 0..1 Not Used dateTime  
- - assigner 0..1 Not Used Reference ( CareConnect-Organization-1 )  
- - - reference 0..1 Not Used String  
- - - identifier 0..1 Not Used Identifier  
- - - display 0..1 Not Used String  
- - definition 0..* Not Used Reference  
    Not Used PlanDefinition  
    Not Used ActivityDefinition  
    Not Used CareConnect-NHSD-HealthcareService-1  
- - - reference 0..1 Not Used String  
- - - identifier 0..1 Not Used Identifier  
- - - display 0..1 Not Used String  
- - basedOn 0..* Not Used Reference  
    Not Used CarePlan  
    Not Used ProcedureRequest  
    Not Used ReferralRequest  
- - - reference 0..1 Not Used String  
- - - identifier 0..1 Not Used Identifier  
- - - display 0..1 Not Used String  
- - partOf 0..* Not Used Reference Part of referenced event
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Not Used MedicationAdministration  
    Optional CareConnect-Procedure-1 A refernce to a Procedure which this procedure is a part of.
    Optional CareConnect-Observation-1 A refernce to a Observation which this procedure is a part of.
- - - reference 0..1 Mandatory String The UUID of the referred to resource instant in the message bundle
- - - identifier 0..1 Not Used Identifier  
- - - display 0..1 Not Used String  
- - status 1..1 Mandatory Code preparation : in-progress : suspended : aborted : completed : entered-in-error : unknown. Binding (required): A code specifying the state of the procedure. MUST be fixed to completed ( http://hl7.org/fhir/stu3/valueset-event-status.html )
- - notDone 0..1 Not Used Boolean  
- - notDoneReason 0..1 Not Used CodeableConcept  
- - - coding 0..* Not Used Coding  
- - - - system 0..1 Not Used Uri  
- - - - version 0..1 Not Used String  
- - - - code 0..1 Not Used Code  
- - - - display 0..1 Not Used String  
- - - - userSelected 0..1 Not Used Boolean  
- - - text 0..1 Not Used String  
- - category 0..1 Not Used CodeableConcept  
- - - coding 0..* Not Used Coding  
- - - - system 0..1 Not Used Uri  
- - - - version 0..1 Not Used String  
- - - - code 0..1 Not Used Code  
- - - - display 0..1 Not Used String  
- - - - userSelected 0..1 Not Used Boolean  
- - - text 0..1 Not Used String  
- - code 0..1 Mandatory CodeableConcept A SNOMED CT Concept to describe the procedure performed.
- - - coding 0..* Mandatory Coding Code defined by a terminology system
Slicing: Discriminator: system, Ordering: false, Rules: Open
- - - coding (snomedCT) 0..1 Mandatory Coding Code defined by a terminology system. Binding (extensible): A code from the SNOMED Clinical Terminology UK. (https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ProcedureCode-1 )
- - - - extension (snomedCTDescriptionID) 0..1 Optional Extension The SNOMED CT Description ID for the display. Constraint (ext-1): Must have either extensions or value[x], not both. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
- - - - system 1..1 Mandatory Uri Identity of the terminology system. MUST contain the fixed Value: http://snomed.info/sct
- - - - code 1..1 Mandatory Code Must contain a SNOMED CT concept that conforms to the following expression:
”«71388002 ||Procedure| OR
«129125009 ||Procedure with explicit context|
- - - - display 1..1 Mandatory String The prefferred term for the SNOMED CT concept
- - - - userSelected 0..1 Optional Boolean If this coding was chosen directly by the user
- - - text 0..1 Not Used String  
- - subject 1..1 Mandatory Reference Who the procedure was performed on
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Not Used Group  
    Mandatory CareConnect-Patient-1  
- - - reference 0..1 Mandatory 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 Mandatory Reference Encounter or episode associated with the procedure
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Not Used EpisodeOfCare  
    Mandatory CareConnect-Encounter-1  
- - - reference 0..1 Mandatory 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
- - performed[x] 0..1 Required dateTime Date the procedure was performed
    Required Period The Period the procedure was performed
- - performer 0..* Required BackboneElement The people who performed the procedure
- - - modifierExtension 0..* Not Used Extension Extensions that cannot be ignored
Constraint (ext-1): Must have either extensions or value[x], not both
- - - role 0..1 Required CodeableConcept The role the actor was in. Binding (example): A code that identifies the role of a performer of the procedure. (http://hl7.org/fhir/stu3/valueset-performer-role.html )
- - - - coding 0..* Mandatory Coding Code defined by a terminology system
- - - - system 0..1 Mandatory Uri Identity of the terminology system
- - - - version 0..1 Not Used String Version of the system - if relevant
- - - - code 0..1 Mandatory Code Symbol in syntax defined by the system
- - - - display 0..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
- - actor 1..1 Mandatory Reference The reference to the practitioner
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Not Used RelatedPerson  
    Not Used Device  
    Not Used CareConnect-Organization-1  
    Not Used CareConnect-Patient-1  
    Mandatory CareConnect-Practitioner-1  
- - - reference 0..1 Mandatory 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 Required Reference ( CareConnect-Organization-1 ) Organization the device or practitioner was acting for
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
- - - reference 0..1 Mandatory 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
- - location 0..1 Required Reference ( CareConnect-Location-1 ) Where the procedure happened
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
- - - reference 0..1 Mandatory 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..* Optional CodeableConcept Coded reason procedure performed. Binding (example): A code that identifies the reason a procedure is required. (http://hl7.org/fhir/stu3/valueset-procedure-reason.html )
- - - coding 0..* Mandatory Coding Code defined by a terminology system
- - - - system 0..1 Mandatory Uri Identity of the terminology system
- - - - version 0..1 Not Used String Version of the system - if relevant
- - - - code 0..1 Mandatory Code Symbol in syntax defined by the system
- - - - display 0..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
- - reasonReference 0..* Required Reference Condition that is the reason the procedure performed
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-Observation-1  
    Optional CareConnect-Condition-1  
- - - reference 0..1 Mandatory 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..* Required CodeableConcept Target body sites. Binding (example): Codes describing anatomical locations. May include laterality. (http://hl7.org/fhir/stu3/valueset-body-site.html )
- - - coding 0..* Mandatory Coding Code defined by a terminology system
Slicing: Discriminator: system, Ordering: false, Rules: Open
- - - - coding (snomedCT) 0..1 Mandatory Coding Code defined by a terminology system. Binding (extensible): A code from the SNOMED Clinical Terminology UK. (https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-BodySite-1 )
- - - - extension (snomedCTDescriptionID) 0..1 Optional Extension The SNOMED CT Description ID for the display. Constraint (ext-1): Must have either extensions or value[x], not both. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
- - - - system 1..1 Mandatory Uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
- - - - 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
- - outcome 0..1 Required CodeableConcept The result of procedure. Binding (example): An outcome of a procedure - whether it was resolved or otherwise. (http://hl7.org/fhir/stu3/valueset-procedure-outcome.html )
- - - coding 0..* Mandatory Coding Code defined by a terminology system
- - - - system 0..1 Mandatory Uri Identity of the terminology system
- - - - version 0..1 Not Used String Version of the system - if relevant
- - - - code 0..1 Mandatory Code Symbol in syntax defined by the system
- - - - display 0..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
- - report 0..* Required Reference ( DiagnosticReport) Any report resulting from the procedure
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
- - - reference 0..1 Mandatory 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
- - complication 0..* Required CodeableConcept Complication following the procedure. Binding (example): Codes describing complications that resulted from a procedure. (http://hl7.org/fhir/stu3/valueset-condition-code.html )
- - - coding 0..* Mandatory Coding Code defined by a terminology system
Slicing: Discriminator: system, Ordering: false, Rules: Open
- - - coding (snomedCT) 0..1 Mandatory Coding Code defined by a terminology system. Binding (required): A code from the SNOMED Clinical Terminology UK. (https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ConditionCode-1 )
- - - - extension (snomedCTDescriptionID) 0..1 Not Used Extension The SNOMED CT Description ID for the display. Constraint (ext-1): Must have either extensions or value[x], not both. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
- - - - system 1..1 Mandatory Uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
- - - - 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
- - complicationDetail 0..* Optional Reference ( CareConnect-Condition-1 ) A condition that is a result of the procedure
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
- - - reference 0..1 Mandatory 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
- - followUp 0..* Required CodeableConcept Instructions for follow up. Binding (example): Specific follow up required for a procedure e.g. removal of sutures. (http://hl7.org/fhir/stu3/valueset-procedure-followup.html )
- - - - coding 0..* Mandatory Coding Code defined by a terminology system
- - - - system 0..1 Mandatory Uri Identity of the terminology system
- - - - version 0..1 Not Used String Version of the system - if relevant
- - - - code 0..1 Mandatory Code Symbol in syntax defined by the system
- - - - display 0..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
- - note 0..* Optional Annotation Additional information about the procedure
- - - author[x] 0..1 Required Reference Individual responsible for the annotation
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Not Used RelatedPerson  
    Not Used CareConnect-Patient-1  
    Mandatory CareConnect-Practitioner-1  
    Not Used String  
- - - time 0..1 Optional dateTime When the annotation was made
- - - text 1..1 Mandatory String The annotation - text content
- - focalDevice 0..* Optional BackboneElement Device changed in procedure
- - - modifierExtension 0..* Not Used Extension Extensions that cannot be ignored
Constraint (ext-1): Must have either extensions or value[x], not both
- - - action 0..1 Not Used CodeableConcept Kind of change to device. Binding (preferred): A kind of change that happened to the device during the procedure. (http://hl7.org/fhir/stu3/valueset-device-action.html )
- - - - 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
- - - manipulated 1..1 Not Used Reference ( Device ) Device that was changed
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
- - - - 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
- - usedReference 0..* Optional Reference Items used during procedure
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional Device  
    Optional Substance  
    Optional CareConnect-Medication-1  
- - - reference 0..1 Mandatory 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
- - usedCode 0..* Required CodeableConcept Coded items used during the procedure. Binding (example): Codes describing items used during a procedure ( http://hl7.org/fhir/stu3/valueset-device-kind.html )
- - - coding 0..* Mandatory Coding Code defined by a terminology system
- - - - system 0..1 Mandatory Uri Identity of the terminology system
- - - - version 0..1 Not Used String Version of the system - if relevant
- - - - code 0..1 Mandatory Code Symbol in syntax defined by the system
- - - - display 0..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
Tags: overview

All content is available under the Open Government Licence v3.0, except where otherwise stated