Skip to content

Commit

Permalink
docs: updated links
Browse files Browse the repository at this point in the history
  • Loading branch information
@glichtner
glichtner committed Feb 17, 2024
1 parent aa43a18 commit b3fa39b
Show file tree
Hide file tree
Showing 6 changed files with 62 additions and 62 deletions.
38 changes: 19 additions & 19 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,42 +27,42 @@ The following elements are required to represent a clinical practice guideline r

| Name | FHIR Base Resource | Description | References |
| ---- | ------------- | ----------- | ---------- |
| [Recommendation][Recommendation] | [PlanDefinition](http://hl7.org/fhir/R5/plandefinition.html) | Representation of a single guideline recommendation. | [Recommendation Plan][Recommendation Plan], [Guideline Citation][Guideline Citation], [Recommendation Citation][Recommendation Citation]. |
| [Recommendation Plan][Recommendation Plan] | [PlanDefinition](http://hl7.org/fhir/R5/plandefinition.html) | Description of a recommended intervention addressed in a specific guideline recommendation. | [Intervention Activities][Recommendation Action] specified in the guideline recommendation; [Recommendation Eligibility Criteria][Recommendation Eligibility Criteria] defining the group of patients to which the recommendation applies to; [Recommendation Justification][Recommendation Justification] providing the justification of the recommendation; [Guideline Citation][Guideline Citation], [Recommendation Citation][Recommendation Citation]. |
| [Recommendation Action][Recommendation Action] | [ActivityDefinition](http://hl7.org/fhir/R5/activitydefinition.html) | Definition of an activity that is part of an intervention in the context of a clinical practice guideline recommendation. | - |
| [Recommendation Eligibility Criteria][Recommendation Eligibility Criteria] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Description of the population to which a specific guideline recommendation applies. | - |
| [Recommendation][SD:Recommendation] | [PlanDefinition](http://hl7.org/fhir/R5/plandefinition.html) | Representation of a single guideline recommendation. | [Recommendation Plan][SD:Recommendation Plan], [Guideline Citation][SD:Guideline Citation], [Recommendation Citation][SD:Recommendation Citation]. |
| [Recommendation Plan][SD:Recommendation Plan] | [PlanDefinition](http://hl7.org/fhir/R5/plandefinition.html) | Description of a recommended intervention addressed in a specific guideline recommendation. | [Intervention Activities][SD:Recommendation Action] specified in the guideline recommendation; [Recommendation Eligibility Criteria][SD:Recommendation Eligibility Criteria] defining the group of patients to which the recommendation applies to; [Recommendation Justification][SD:Recommendation Justification] providing the justification of the recommendation; [Guideline Citation][SD:Guideline Citation], [Recommendation Citation][SD:Recommendation Citation]. |
| [Recommendation Action][SD:Recommendation Action] | [ActivityDefinition](http://hl7.org/fhir/R5/activitydefinition.html) | Definition of an activity that is part of an intervention in the context of a clinical practice guideline recommendation. | - |
| [Recommendation Eligibility Criteria][SD:Recommendation Eligibility Criteria] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Description of the population to which a specific guideline recommendation applies. | - |


The following profiles are used to represent the evidence upon which a clinical practice guideline recommendation is based:

| Name | FHIR Base Resource | Description | References |
| ---- | ------------- | ----------- | ---------- |
| [Study Outcome Evidence][Study Outcome Evidence] | [Evidence](http://hl7.org/fhir/R5/evidence.html) | Evidence statistics generated from a single study or systematic review regarding a clinical question. | [Study Eligibility Criteria][Study Eligibility Criteria], [Intervention Definition][Intervention Definition], [Outcome Definition][Outcome Definition], [Study Citation][Study Citation] |
| [Study Eligibility Criteria][Study Eligibility Criteria] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Intended definition of the patient group for which evidence or was generated or evidence synthesis was performed. | - |
| [Study Cohort][Study Cohort] | [Group](http://hl7.org/fhir/R5/group.html) | Actual composition of the patient group for which the evidence was generated. | - |
| [Outcome Evidence Synthesis][Outcome Evidence Synthesis] | [Evidence](http://hl7.org/fhir/R5/evidence.html) | A single evidence for an outcome from an evidence synthesis (e.g., meta-analysis). | [Evidence Synthesis Cohorts][Evidence Synthesis Cohorts], [Evidence Data Set][Evidence Data Set] |
| [Evidence Synthesis Cohorts][Evidence Synthesis Cohorts] | [Group](http://hl7.org/fhir/R5/group.html) | Actual composition of the patient group for which evidence synthesis was performed. | - |
| [Intervention Definition][Intervention Definition] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Definition of an intervention or comparison with respect to which evidence was generated. | - |
| [Outcome Definition][Outcome Definition] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Definition of the outcome for which evidence was generated. | - |
| [Evidence Data Set][Evidence Data Set] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Definition of the outcome used as the observed measured variable for an evidence synthesis. | - |
| [Outcome Evidence][Outcome Evidence] | [Evidence](http://hl7.org/fhir/R5/evidence.html) | Evidence statistics generated from a single study or systematic review regarding a clinical question. | [Study Eligibility Criteria][Study Eligibility Criteria], [Intervention Definition][Intervention Definition], [Outcome Definition][Outcome Definition], [Study Citation][Study Citation] |
| [Study Eligibility Criteria][Study Eligibility Criteria] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Definition of the patient group for which evidence was generated. | - |
| [Study Outcome Evidence][SD:Study Outcome Evidence] | [Evidence](http://hl7.org/fhir/R5/evidence.html) | Evidence statistics generated from a single study or systematic review regarding a clinical question. | [Study Eligibility Criteria][SD:Study Eligibility Criteria], [Intervention Definition][SD:Intervention Definition], [Outcome Definition][SD:Outcome Definition], [Study Citation][SD:Study Citation] |
| [Study Eligibility Criteria][SD:Study Eligibility Criteria] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Intended definition of the patient group for which evidence or was generated or evidence synthesis was performed. | - |
| [Study Cohort][SD:Study Cohort] | [Group](http://hl7.org/fhir/R5/group.html) | Actual composition of the patient group for which the evidence was generated. | - |
| [Outcome Evidence Synthesis][SD:utcome Evidence Synthesis] | [Evidence](http://hl7.org/fhir/R5/evidence.html) | A single evidence for an outcome from an evidence synthesis (e.g., meta-analysis). | [Evidence Synthesis Cohorts][SD:Evidence Synthesis Cohorts], [Evidence Data Set][SD:Evidence Data Set] |
| [Evidence Synthesis Cohorts][SD:Evidence Synthesis Cohorts] | [Group](http://hl7.org/fhir/R5/group.html) | Actual composition of the patient group for which evidence synthesis was performed. | - |
| [Intervention Definition][SD:Intervention Definition] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Definition of an intervention or comparison with respect to which evidence was generated. | - |
| [Outcome Definition][SD:Outcome Definition] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Definition of the outcome for which evidence was generated. | - |
| [Evidence Data Set][SD:Evidence Data Set] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Definition of the outcome used as the observed measured variable for an evidence synthesis. | - |
| [Outcome Evidence][OSD:utcome Evidence] | [Evidence](http://hl7.org/fhir/R5/evidence.html) | Evidence statistics generated from a single study or systematic review regarding a clinical question. | [Study Eligibility Criteria][SD:Study Eligibility Criteria], [Intervention Definition][Intervention Definition], [Outcome Definition][SD:Outcome Definition], [Study Citation][SD:Study Citation] |
| [Study Eligibility Criteria][SD:Study Eligibility Criteria] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Definition of the patient group for which evidence was generated. | - |

The following profiles are used to represent the assessment of evidence which justify the recommendation:

| Name | FHIR Base Resource | Description | References |
| ---- | ------------- | ----------- | ---------- |
| [Recommendation Justification][Recommendation Justification] | [ArtifactAssessment](http://hl7.org/fhir/R5/artifactassessment.html) | Rating of the recommendation given all evidence for all considered outcomes. | [Recommendation Plan][Recommendation Plan], [Certainty of Evidence Rating][Certainty of Evidence Rating], [Net Effect Estimate][Net Effect Estimate] |
| [Certainty of Evidence Rating][Certainty of Evidence Rating] | [ArtifactAssessment](http://hl7.org/fhir/R5/artifactassessment.html) | Rating of the evidence for individual outcomes. | [Outcome Evidence][Outcome Evidence] |
| [Net Effect Estimate][Net Effect Estimate] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Description of the net effect of a guideline recommendation. | (Expected) [Outcomes][Outcome Definition] of a guideline recommendation. |
| [Recommendation Justification][SD:Recommendation Justification] | [ArtifactAssessment](http://hl7.org/fhir/R5/artifactassessment.html) | Rating of the recommendation given all evidence for all considered outcomes. | [Recommendation Plan][SD:Recommendation Plan], [Certainty of Evidence Rating][SD:Certainty of Evidence Rating], [Net Effect Estimate][SD:Net Effect Estimate] |
| [Certainty of Evidence Rating][SD:Certainty of Evidence Rating] | [ArtifactAssessment](http://hl7.org/fhir/R5/artifactassessment.html) | Rating of the evidence for individual outcomes. | [Outcome Evidence][SD:Outcome Evidence] |
| [Net Effect Estimate][SD:Net Effect Estimate] | [EvidenceVariable](http://hl7.org/fhir/R5/evidencevariable.html) | Description of the net effect of a guideline recommendation. | (Expected) [Outcomes][SD:Outcome Definition] of a guideline recommendation. |


Additionally, the following profiles are used to bundle recommendations and resources:

| Name | FHIR Base Resource | Description | References |
| ---- | ------------- | ----------- | ---------- |
| [Clinical Practice Guideline][Clinical Practice Guideline] | [Composition](http://hl7.org/fhir/R5/composition.html) | Composition of several individual guideline recommendations | [Recommendation Plan][Recommendation Plan], [Guideline Citation][Guideline Citation] |
| [Guideline Bundle][Guideline Bundle] | [Bundle](http://hl7.org/fhir/R5/bundle.html) | Bundle of all resources of a single clinical practice guideline. | All other resources in this IG. |
| [Clinical Practice Guideline][SD:Clinical Practice Guideline] | [Composition](http://hl7.org/fhir/R5/composition.html) | Composition of several individual guideline recommendations | [Recommendation Plan][SD:Recommendation Plan], [Guideline Citation][SD:Guideline Citation] |
| [Guideline Bundle][SD:Guideline Bundle] | [Bundle](http://hl7.org/fhir/R5/bundle.html) | Bundle of all resources of a single clinical practice guideline. | All other resources in this IG. |


## Examples
Expand Down
12 changes: 6 additions & 6 deletions input/includes/categories-intervention.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
### Categories

The following categories are used to describe the intervention action in the [Recommendation Plan resource][Recommendation Plan].
The following categories are used to describe the intervention action in the [Recommendation Plan profile][SD:Recommendation Plan].

The categories are defined as slices of the `action` element in the [Recommendation Plan resource][Recommendation Plan].
The categories are defined as slices of the `action` element in the [Recommendation Plan profile][SD:Recommendation Plan].

> Fixed Codes:
>
Expand All @@ -12,17 +12,17 @@ The categories are defined as slices of the `action` element in the [Recommendat
| Type | .action Slice Name | .goal Slice Name | Action ProfileName |
| --- | --- | --- | --- |
| Drug Administration | drugAdministration | <center>❌ *not required* </center> | [Drug Administration Action][Drug Administration Action] |
| Drug Administration | drugAdministration | <center>❌ *not required* </center> | [Drug Administration Action][SD:Drug Administration Action] |
| Laboratory Observation | <center> ❌ *not required*<br>⚠️ *this might change* </center> | laboratoryValue | *n/a* |
| Ventilation Measure/Setting | ventilatorManagement | ventilatorManagement | *n/a* |
| Body position | bodyPositioning | <center>❌ *not required* </center> | [Body Positioning Action][Body Positioning Action] |
| Body position | bodyPositioning | <center>❌ *not required* </center> | [Body Positioning Action][SD:Body Positioning Action] |
| Sedation Management | sedationManagement | assessmentScale | n/a |
| Pain Management | painManagement | assessmentScale | n/a |
| Assessment | assessment | any | [Assessment Action][Assessment Action] |
| Assessment | assessment | any | [Assessment Action][SD:Assessment Action] |
| Any other / Custom | other | <center>❌ *not required* </center> | *n/a* |
{:.grid}

For nested actions, you must use the `combination` slice of the `action` element in the [Recommendation Plan resource][Recommendation Plan].
For nested actions, you must use the `combination` slice of the `action` element in the [Recommendation Plan profile][SD:Recommendation Plan].

| Type | .action Slice Name | .goal Slice Name | Action ProfileName |
| --- | --- | --- | --- |
Expand Down
24 changes: 12 additions & 12 deletions input/intro-notes/StructureDefinition-guideline-bundle-intro.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@
This bundle is used to collect all resources of a specific clinical practice guideline. It contains the following resources:

* Required
* [Guideline][Guideline]
* [Recommendation][Recommendation]
* [Recommendation Plan][Recommendation Plan]
* [PICO Evidence Variable][PICO Evidence Variable] (includes [Recommendation Eligibility Criteria][Recommendation Eligibility Criteria], [Study Eligibility Criteria][Study Eligibility Criteria], [Outcome Definition][Outcome Definition] and [Intervention Definition][Intervention Definition])
* [Recommendation Action][Recommendation Action]
* [Recommendation Justification][Recommendation Justification]
* [Guideline][SD:Guideline]
* [Recommendation][SD:Recommendation]
* [Recommendation Plan][SD:Recommendation Plan]
* [PICO Evidence Variable][SD:PICO Evidence Variable] (includes [Recommendation Eligibility Criteria][SD:Recommendation Eligibility Criteria], [Study Eligibility Criteria][SD:Study Eligibility Criteria], [Outcome Definition][SD:Outcome Definition] and [Intervention Definition][SD:Intervention Definition])
* [Recommendation Action][SD:Recommendation Action]
* [Recommendation Justification][SD:Recommendation Justification]
* Optional
* [Certainty of Evidence Rating][Certainty of Evidence Rating]
* [Outcome Evidence][Outcome Evidence]
* [Study Citation][Study Citation]
* [Recommendation Citation][Recommendation Citation]
* [Guideline Citation][Guideline Citation]
* [Net Effect Estimate][Net Effect Estimate]
* [Certainty of Evidence Rating][SD:Certainty of Evidence Rating]
* [Outcome Evidence][SD:Outcome Evidence]
* [Study Citation][SD:Study Citation]
* [Recommendation Citation][SD:Recommendation Citation]
* [Guideline Citation][SD:Guideline Citation]
* [Net Effect Estimate][SD:Net Effect Estimate]

{% capture resource_inheritance %}
This profile of a FHIR {{resource.type}} is derived from the [{{resource.base | split: '/' | last}}]({{resource.base}}) FHIR resource.
Expand Down
8 changes: 4 additions & 4 deletions input/intro-notes/StructureDefinition-recommendation-action-intro.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

### Guidance

This profile defines a specific recommended activity as part of an intervention recommended by a specific [Recommendation][Recommendation].
This profile defines a specific recommended activity as part of an intervention recommended by a specific [Recommendation][SD:Recommendation].

The actions defined using this profile are combined to a plan using the [Recommendation Plan profile][Recommendation Plan].
The actions defined using this profile are combined to a plan using the [Recommendation Plan profile][SD:Recommendation Plan].

The following profiles are used to define specific actions:
* [Body Positioning Action][Body Positioning Action] - for describing the action of positioning a patient
* [Drug Administration Action][Drug Administration Action] - for describing the action of administering a drug
* [Body Positioning Action][SD:Body Positioning Action] - for describing the action of positioning a patient
* [Drug Administration Action][SD:Drug Administration Action] - for describing the action of administering a drug

{% include fhir-structure-detailed.md name='08-intervention-activity' alt='FHIR Intervention Activity' %}

Expand Down
4 changes: 2 additions & 2 deletions input/intro-notes/StructureDefinition-recommendation-plan-intro.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

### Guidance

This profile defines a specific recommended plan as part of an intervention recommended by a specific [Recommendation][Recommendation].
This profile defines a specific recommended plan as part of an intervention recommended by a specific [Recommendation][SD:Recommendation].

The actions to be performed are specified using the [Recommendation Action][Recommendation Action].
The actions to be performed are specified using the [Recommendation Action][SD:Recommendation Action].

{% include categories-intervention.md %}

Expand Down
Loading

0 comments on commit b3fa39b

Please sign in to comment.