RareLink Implementation Guide
2.0.0 - 2.0.0
RareLink Implementation Guide - Local Development build (v2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/rarelink-ips-procedure | Version: 2.0.0 | |||
Draft as of 2025-06-03 | Computable Name: RareLinkIPSProcedure |
A RareLink-specific profile for the IPS Procedure resource.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ProcedureUvIps
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ProcedureUvIps | An action that is being or was performed on a patient | |
![]() ![]() ![]() |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | CodingIPS | A reference to a code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Binding: Procedures - IPS (required) | |
![]() ![]() ![]() |
1..1 | Reference(RareLink IPS Patient) | Who the procedure was performed on | |
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
![]() |
Path | Conformance | ValueSet | URI |
Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status From the FHIR Standard | |
Procedure.code.coding.system | required | ProceduresUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ProcedureUvIps | An action that is being or was performed on a patient | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) |
![]() ![]() ![]() |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Procedures - IPS (preferred): SNOMED CT procedure code set or a code for absent/unknown procedure |
![]() ![]() ![]() ![]() |
S | 1..1 | CodingIPS | A reference to a code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system Binding: Procedures - IPS (required) |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(RareLink IPS Patient) | Who the procedure was performed on |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
SΣ | 1..1 | When the procedure was performed | |
![]() ![]() ![]() ![]() |
Content/Rules for all Types | |||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | performed[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example) | |
![]() ![]() ![]() ![]() |
S | 0..* | CodingIPS | A reference to a code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() |
Path | Conformance | ValueSet | URI |
Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status From the FHIR Standard | |
Procedure.code | preferred | ProceduresUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips | |
Procedure.code.coding.system | required | ProceduresUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips | |
Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Procedure | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | 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-5 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Procedure | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | ProcedureUvIps | An action that is being or was performed on a patient | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Identifiers for this procedure | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Procedures - IPS (preferred): SNOMED CT procedure code set or a code for absent/unknown procedure | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | CodingIPS | A reference to a code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system Binding: Procedures - IPS (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(RareLink IPS Patient) | Who the procedure was performed on | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
SΣ | 1..1 | When the procedure was performed | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all Types | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | performed[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | ||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The people who performed the procedure | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient (IPS) | RelatedPerson | Device - performer, observer | Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS)) | The reference to the practitioner | ||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization (IPS)) | Organization the device or practitioner was acting for | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed | ||||
![]() ![]() ![]() |
0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | CodingIPS | A reference to a code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||
![]() ![]() ![]() |
0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||
![]() ![]() ![]() |
0..* | Reference(Condition) | A condition that is a result of the procedure | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||
![]() ![]() ![]() |
0..* | Annotation | Additional information about the procedure | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Manipulated, implanted, or removed device | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Device) | Device that was changed | |||||
![]() ![]() ![]() |
0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Procedure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status From the FHIR Standard | ||||
Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT)http://hl7.org/fhir/ValueSet/procedure-not-performed-reason From the FHIR Standard | ||||
Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-category From the FHIR Standard | ||||
Procedure.code | preferred | ProceduresUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips | ||||
Procedure.code.coding.system | required | ProceduresUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips | ||||
Procedure.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
Procedure.performer.function | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role From the FHIR Standard | ||||
Procedure.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason From the FHIR Standard | ||||
Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site From the FHIR Standard | ||||
Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-outcome From the FHIR Standard | ||||
Procedure.complication | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code From the FHIR Standard | ||||
Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-followup From the FHIR Standard | ||||
Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodeshttp://hl7.org/fhir/ValueSet/device-action From the FHIR Standard | ||||
Procedure.usedCode | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Procedure | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | 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-5 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Procedure | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ProcedureUvIps
Differential View
This structure is derived from ProcedureUvIps
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ProcedureUvIps | An action that is being or was performed on a patient | |
![]() ![]() ![]() |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | CodingIPS | A reference to a code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Binding: Procedures - IPS (required) | |
![]() ![]() ![]() |
1..1 | Reference(RareLink IPS Patient) | Who the procedure was performed on | |
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
![]() |
Path | Conformance | ValueSet | URI |
Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status From the FHIR Standard | |
Procedure.code.coding.system | required | ProceduresUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ProcedureUvIps | An action that is being or was performed on a patient | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) |
![]() ![]() ![]() |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Procedures - IPS (preferred): SNOMED CT procedure code set or a code for absent/unknown procedure |
![]() ![]() ![]() ![]() |
S | 1..1 | CodingIPS | A reference to a code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system Binding: Procedures - IPS (required) |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(RareLink IPS Patient) | Who the procedure was performed on |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
SΣ | 1..1 | When the procedure was performed | |
![]() ![]() ![]() ![]() |
Content/Rules for all Types | |||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | performed[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example) | |
![]() ![]() ![]() ![]() |
S | 0..* | CodingIPS | A reference to a code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() |
Path | Conformance | ValueSet | URI |
Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status From the FHIR Standard | |
Procedure.code | preferred | ProceduresUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips | |
Procedure.code.coding.system | required | ProceduresUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips | |
Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Procedure | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | 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-5 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Procedure | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | ProcedureUvIps | An action that is being or was performed on a patient | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Identifiers for this procedure | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Procedures - IPS (preferred): SNOMED CT procedure code set or a code for absent/unknown procedure | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | CodingIPS | A reference to a code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system Binding: Procedures - IPS (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(RareLink IPS Patient) | Who the procedure was performed on | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
SΣ | 1..1 | When the procedure was performed | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all Types | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | performed[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | ||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The people who performed the procedure | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient (IPS) | RelatedPerson | Device - performer, observer | Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS)) | The reference to the practitioner | ||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization (IPS)) | Organization the device or practitioner was acting for | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed | ||||
![]() ![]() ![]() |
0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | CodingIPS | A reference to a code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||
![]() ![]() ![]() |
0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||
![]() ![]() ![]() |
0..* | Reference(Condition) | A condition that is a result of the procedure | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||
![]() ![]() ![]() |
0..* | Annotation | Additional information about the procedure | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Manipulated, implanted, or removed device | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Device) | Device that was changed | |||||
![]() ![]() ![]() |
0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Procedure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status From the FHIR Standard | ||||
Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT)http://hl7.org/fhir/ValueSet/procedure-not-performed-reason From the FHIR Standard | ||||
Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-category From the FHIR Standard | ||||
Procedure.code | preferred | ProceduresUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips | ||||
Procedure.code.coding.system | required | ProceduresUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips | ||||
Procedure.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
Procedure.performer.function | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role From the FHIR Standard | ||||
Procedure.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason From the FHIR Standard | ||||
Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site From the FHIR Standard | ||||
Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-outcome From the FHIR Standard | ||||
Procedure.complication | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code From the FHIR Standard | ||||
Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-followup From the FHIR Standard | ||||
Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodeshttp://hl7.org/fhir/ValueSet/device-action From the FHIR Standard | ||||
Procedure.usedCode | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Procedure | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | 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-5 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Procedure | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ProcedureUvIps
Other representations of profile: CSV, Excel, Schematron