INTEROPen CareConnect Base STU3 Implementation Guide
3.0.0 - CI Build
INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
Procedure Request
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-ProcedureRequest-1
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ProcedureRequest
Summary
Mandatory: 0 element (14 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from ProcedureRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProcedureRequest | I | 0..* | ProcedureRequest | A request for a procedure or diagnostic to be performed |
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 | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Identifiers assigned to this order |
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(ActivityDefinition | PlanDefinition) | Protocol or definition |
basedOn | Σ | 0..* | Reference(Resource) | What request fulfills |
replaces | Σ | 0..* | Reference(Resource) | What request replaces |
requisition | Σ | 0..1 | Identifier | Composite Request ID |
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 | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..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) |
status | ?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled Binding: RequestStatus (required) |
intent | ?!Σ | 1..1 | code | proposal | plan | order + Binding: RequestIntent (required) |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
doNotPerform | ?!Σ | 0..1 | boolean | True if procedure should not be performed |
category | Σ | 0..* | CodeableConcept | Classification of procedure Binding: Procedure Category Codes (SNOMED CT) (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..* | Coding | Code defined by a terminology system |
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 |
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 |
code | Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Procedure Codes (SNOMED CT) (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..* | Coding | Code defined by a terminology system |
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 |
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 | Device | CareConnect-Patient-1 | CareConnect-Location-1) | Individual the service is ordered for |
context | Σ | 0..1 | Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1) | Encounter or Episode during which request was created |
occurrence[x] | Σ | 0..1 | When procedure should occur | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
asNeeded[x] | Σ | 0..1 | Preconditions for procedure or diagnostic Binding: SNOMED CT Medication As Needed Reason Codes (example) | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
authoredOn | Σ | 0..1 | dateTime | Date request signed |
requester | ΣI | 0..1 | BackboneElement | Who/what is requesting procedure or diagnostic |
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 |
agent | Σ | 1..1 | Reference(Device | CareConnect-Practitioner-1 | CareConnect-Organization-1) | Individual making the request |
onBehalfOf | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization agent is acting for |
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: Participant Roles (example) |
performer | Σ | 0..1 | Reference(Device | CareConnect-RelatedPerson-1 | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1) | Requested perfomer |
reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for test Binding: Procedure Reason 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..* | Coding | Code defined by a terminology system |
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 |
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 |
reasonReference | Σ | 0..* | Reference(CareConnect-Observation-1 | CareConnect-Condition-1) | Explanation/Justification for test |
supportingInfo | 0..* | Reference(CareConnect-Observation-1) | Pre-requisites for test | |
specimen | Σ | 0..* | Reference(CareConnect-Specimen-1) | Procedure Samples |
bodySite | Σ | 0..* | CodeableConcept | Location on Body 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..* | Coding | Code defined by a terminology system Binding: Care Connect Body Site (preferred) |
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 |
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 |
note | 0..* | Annotation | Comments | |
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(CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-Patient-1) | |||
authorString | string | |||
time | Σ | 0..1 | dateTime | When the annotation was made |
text | 1..1 | string | The annotation - text content | |
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |
Documentation for this format |
This structure is derived from ProcedureRequest
Summary
Mandatory: 0 element (14 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ProcedureRequest
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProcedureRequest | I | 0..* | ProcedureRequest | A request for a procedure or diagnostic to be performed |
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 | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Identifiers assigned to this order |
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(ActivityDefinition | PlanDefinition) | Protocol or definition |
basedOn | Σ | 0..* | Reference(Resource) | What request fulfills |
replaces | Σ | 0..* | Reference(Resource) | What request replaces |
requisition | Σ | 0..1 | Identifier | Composite Request ID |
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 | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..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) |
status | ?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled Binding: RequestStatus (required) |
intent | ?!Σ | 1..1 | code | proposal | plan | order + Binding: RequestIntent (required) |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
doNotPerform | ?!Σ | 0..1 | boolean | True if procedure should not be performed |
category | Σ | 0..* | CodeableConcept | Classification of procedure Binding: Procedure Category Codes (SNOMED CT) (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..* | Coding | Code defined by a terminology system |
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 |
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 |
code | Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Procedure Codes (SNOMED CT) (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..* | Coding | Code defined by a terminology system |
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 |
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 | Device | CareConnect-Patient-1 | CareConnect-Location-1) | Individual the service is ordered for |
context | Σ | 0..1 | Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1) | Encounter or Episode during which request was created |
occurrence[x] | Σ | 0..1 | When procedure should occur | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
asNeeded[x] | Σ | 0..1 | Preconditions for procedure or diagnostic Binding: SNOMED CT Medication As Needed Reason Codes (example) | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
authoredOn | Σ | 0..1 | dateTime | Date request signed |
requester | ΣI | 0..1 | BackboneElement | Who/what is requesting procedure or diagnostic |
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 |
agent | Σ | 1..1 | Reference(Device | CareConnect-Practitioner-1 | CareConnect-Organization-1) | Individual making the request |
onBehalfOf | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization agent is acting for |
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: Participant Roles (example) |
performer | Σ | 0..1 | Reference(Device | CareConnect-RelatedPerson-1 | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1) | Requested perfomer |
reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for test Binding: Procedure Reason 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..* | Coding | Code defined by a terminology system |
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 |
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 |
reasonReference | Σ | 0..* | Reference(CareConnect-Observation-1 | CareConnect-Condition-1) | Explanation/Justification for test |
supportingInfo | 0..* | Reference(CareConnect-Observation-1) | Pre-requisites for test | |
specimen | Σ | 0..* | Reference(CareConnect-Specimen-1) | Procedure Samples |
bodySite | Σ | 0..* | CodeableConcept | Location on Body 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..* | Coding | Code defined by a terminology system Binding: Care Connect Body Site (preferred) |
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 |
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 |
note | 0..* | Annotation | Comments | |
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(CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-Patient-1) | |||
authorString | string | |||
time | Σ | 0..1 | dateTime | When the annotation was made |
text | 1..1 | string | The annotation - text content | |
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
ProcedureRequest.language | extensible | Common Languages Max Binding: All Languages |
ProcedureRequest.identifier.use | required | IdentifierUse |
ProcedureRequest.identifier.type | extensible | Identifier Type Codes |
ProcedureRequest.requisition.use | required | IdentifierUse |
ProcedureRequest.requisition.type | extensible | Identifier Type Codes |
ProcedureRequest.status | required | RequestStatus |
ProcedureRequest.intent | required | RequestIntent |
ProcedureRequest.priority | required | RequestPriority |
ProcedureRequest.category | example | Procedure Category Codes (SNOMED CT) |
ProcedureRequest.code | example | Procedure Codes (SNOMED CT) |
ProcedureRequest.asNeeded[x] | example | SNOMED CT Medication As Needed Reason Codes |
ProcedureRequest.performerType | example | Participant Roles |
ProcedureRequest.reasonCode | example | Procedure Reason Codes |
ProcedureRequest.bodySite | example | SNOMED CT Body Structures |
ProcedureRequest.bodySite.coding:snomedCT | preferred | Care Connect Body Site |
Id | Path | Details | Requirements |
dom-2 | ProcedureRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | ProcedureRequest | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | ProcedureRequest | 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 | ProcedureRequest | 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() | |
ele-1 | ProcedureRequest.requester | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |