INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
StructureDefinition: CareConnect-Procedure-1
An action that is or was performed on a patient.
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Procedure-1
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Procedure
Summary
Mandatory: 0 element (11 nested mandatory elements)
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Observation-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Condition-1
Extensions
This structure refers to these extensions:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AnaestheticIssues-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
Slices
This structure defines the following Slices:
- The element Procedure.code.coding is sliced based on the value of value:system
- The element Procedure.bodySite.coding is sliced based on the value of value:system
- The element Procedure.complication.coding is sliced based on the value of value:system
This structure is derived from Procedure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Procedure | I | 0..* | Procedure | An action that is being or was performed on a patient |
  id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 Extension-CareConnect-AnaestheticIssues-1 | I | 0..1 | CodeableConcept, Reference(CareConnect-Condition-1) | Details of any adverse reaction to any anaesthetic agents URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AnaestheticIssues-1 Binding: Care Connect Condition Code (required) |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | Σ | 0..* | Identifier | External Identifiers for this procedure |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
  assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| definition | Σ | 0..* | Reference(PlanDefinition | ActivityDefinition | HealthcareService) | Instantiates protocol or definition |
| basedOn | Σ | 0..* | Reference(CarePlan | ProcedureRequest | ReferralRequest) | A request for this procedure |
| partOf | Σ | 0..* | Reference(MedicationAdministration | CareConnect-Procedure-1 | CareConnect-Observation-1) | Part of referenced event |
| status | ?!Σ | 1..1 | code | preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown Binding: EventStatus (required) |
| notDone | ?!Σ | 0..1 | boolean | True if procedure was not performed as scheduled |
| notDoneReason | ΣI | 0..1 | CodeableConcept | Reason procedure was not performed Binding: Procedure Not Performed Reason (SNOMED-CT) (example) |
| category | Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: Procedure Category Codes (SNOMED CT) (example) |
| code | Σ | 0..1 | CodeableConcept | Identification of the procedure Binding: Procedure Codes (SNOMED CT) (preferred) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
 coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
 coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system Binding: Care Connect Procedure Code (extensible) |
  id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
 userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(Group | CareConnect-Patient-1) | Who the procedure was performed on |
| context | Σ | 0..1 | Reference(EpisodeOfCare | CareConnect-Encounter-1) | Encounter or episode associated with the procedure |
 performed[x] | Σ | 0..1 | Date/Period the procedure was performed | |
| performedDateTime | dateTime | |||
| performedPeriod | Period | |||
| performer | ΣI | 0..* | BackboneElement | The people who performed the procedure |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 0..1 | CodeableConcept | The role the actor was in Binding: Procedure Performer Role Codes (example) |
| actor | Σ | 1..1 | Reference(RelatedPerson | Device | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1) | The reference to the practitioner |
| onBehalfOf | 0..1 | Reference(CareConnect-Organization-1) | Organization the device or practitioner was acting for | |
| location | Σ | 0..1 | Reference(CareConnect-Location-1) | Where the procedure happened |
| reasonCode | Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: Procedure Reason Codes (example) |
| reasonReference | Σ | 0..* | Reference(CareConnect-Observation-1 | CareConnect-Condition-1) | Condition that is the reason the procedure performed |
| bodySite | Σ | 0..* | CodeableConcept | Target body sites Binding: SNOMED CT Body Structures (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system Binding: Care Connect Body Site (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| outcome | Σ | 0..1 | CodeableConcept | The result of procedure Binding: Procedure Outcome Codes (SNOMED CT) (example) |
| report | 0..* | Reference(DiagnosticReport) | Any report resulting from the procedure | |
| complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/Diagnosis Codes (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system Binding: Care Connect Condition Code (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| complicationDetail | 0..* | Reference(CareConnect-Condition-1) | A condition that is a result of the procedure | |
| followUp | 0..* | CodeableConcept | Instructions for follow up Binding: Procedure Follow up Codes (SNOMED CT) (example) | |
| note | 0..* | Annotation | Additional information about the procedure | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(RelatedPerson | CareConnect-Patient-1 | CareConnect-Practitioner-1) | |||
| authorString | string | |||
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | 1..1 | string | The annotation - text content | |
| focalDevice | I | 0..* | BackboneElement | Device changed in procedure |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| action | 0..1 | CodeableConcept | Kind of change to device Binding: Procedure Device Action Codes (preferred) | |
| manipulated | 1..1 | Reference(Device) | Device that was changed | |
| usedReference | 0..* | Reference(Device | Substance | CareConnect-Medication-1) | Items used during procedure | |
| usedCode | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIR Device Types (example) | |
| Documentation for this format | ||||
This structure is derived from Procedure
Summary
Mandatory: 0 element (11 nested mandatory elements)
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Observation-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Condition-1
Extensions
This structure refers to these extensions:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AnaestheticIssues-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
Slices
This structure defines the following Slices:
- The element Procedure.code.coding is sliced based on the value of value:system
- The element Procedure.bodySite.coding is sliced based on the value of value:system
- The element Procedure.complication.coding is sliced based on the value of value:system
Differential View
This structure is derived from Procedure
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure | I | 0..* | Procedure | An action that is being or was performed on a patient |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-CareConnect-AnaestheticIssues-1 | I | 0..1 | CodeableConcept, Reference(CareConnect-Condition-1) | Details of any adverse reaction to any anaesthetic agents URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AnaestheticIssues-1 Binding: Care Connect Condition Code (required) |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External Identifiers for this procedure |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| definition | Σ | 0..* | Reference(PlanDefinition | ActivityDefinition | HealthcareService) | Instantiates protocol or definition |
| basedOn | Σ | 0..* | Reference(CarePlan | ProcedureRequest | ReferralRequest) | A request for this procedure |
| partOf | Σ | 0..* | Reference(MedicationAdministration | CareConnect-Procedure-1 | CareConnect-Observation-1) | Part of referenced event |
| status | ?!Σ | 1..1 | code | preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown Binding: EventStatus (required) |
| notDone | ?!Σ | 0..1 | boolean | True if procedure was not performed as scheduled |
| notDoneReason | ΣI | 0..1 | CodeableConcept | Reason procedure was not performed Binding: Procedure Not Performed Reason (SNOMED-CT) (example) |
| category | Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: Procedure Category Codes (SNOMED CT) (example) |
| code | Σ | 0..1 | CodeableConcept | Identification of the procedure Binding: Procedure Codes (SNOMED CT) (preferred) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system Binding: Care Connect Procedure Code (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(Group | CareConnect-Patient-1) | Who the procedure was performed on |
| context | Σ | 0..1 | Reference(EpisodeOfCare | CareConnect-Encounter-1) | Encounter or episode associated with the procedure |
| performed[x] | Σ | 0..1 | Date/Period the procedure was performed | |
| performedDateTime | dateTime | |||
| performedPeriod | Period | |||
| performer | ΣI | 0..* | BackboneElement | The people who performed the procedure |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 0..1 | CodeableConcept | The role the actor was in Binding: Procedure Performer Role Codes (example) |
| actor | Σ | 1..1 | Reference(RelatedPerson | Device | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1) | The reference to the practitioner |
| onBehalfOf | 0..1 | Reference(CareConnect-Organization-1) | Organization the device or practitioner was acting for | |
| location | Σ | 0..1 | Reference(CareConnect-Location-1) | Where the procedure happened |
| reasonCode | Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: Procedure Reason Codes (example) |
| reasonReference | Σ | 0..* | Reference(CareConnect-Observation-1 | CareConnect-Condition-1) | Condition that is the reason the procedure performed |
| bodySite | Σ | 0..* | CodeableConcept | Target body sites Binding: SNOMED CT Body Structures (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system Binding: Care Connect Body Site (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| outcome | Σ | 0..1 | CodeableConcept | The result of procedure Binding: Procedure Outcome Codes (SNOMED CT) (example) |
| report | 0..* | Reference(DiagnosticReport) | Any report resulting from the procedure | |
| complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/Diagnosis Codes (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system Binding: Care Connect Condition Code (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| complicationDetail | 0..* | Reference(CareConnect-Condition-1) | A condition that is a result of the procedure | |
| followUp | 0..* | CodeableConcept | Instructions for follow up Binding: Procedure Follow up Codes (SNOMED CT) (example) | |
| note | 0..* | Annotation | Additional information about the procedure | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(RelatedPerson | CareConnect-Patient-1 | CareConnect-Practitioner-1) | |||
| authorString | string | |||
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | 1..1 | string | The annotation - text content | |
| focalDevice | I | 0..* | BackboneElement | Device changed in procedure |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| action | 0..1 | CodeableConcept | Kind of change to device Binding: Procedure Device Action Codes (preferred) | |
| manipulated | 1..1 | Reference(Device) | Device that was changed | |
| usedReference | 0..* | Reference(Device | Substance | CareConnect-Medication-1) | Items used during procedure | |
| usedCode | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIR Device Types (example) | |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
Constraints
Constraints
| Id | Path | Details | Requirements |
| dom-2 | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Procedure | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | Procedure | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-3 | Procedure | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| pro-1 | Procedure | Reason not done is only permitted if notDone indicator is true : notDoneReason.empty() or notDone = true | |
| ele-1 | Procedure.extension:anaestheticIssues | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Procedure.extension:anaestheticIssues | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.performer | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Procedure.focalDevice | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |