Skip to content

Commit

Permalink
Merge pull request #170 from fhir-fi/warn-for-bad-examples
Browse files Browse the repository at this point in the history
Add warnings for failing examples
  • Loading branch information
mrinnetmaki authored Oct 26, 2023
2 parents 98bcf0a + 6844ffb commit fdcbde8
Show file tree
Hide file tree
Showing 30 changed files with 111 additions and 0 deletions.
7 changes: 7 additions & 0 deletions input/includes/fragment-kanta-meds-warning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{:.dragon}
This example does not validate properly. It has been imported from an implementation guide for the
Kanta Prescription system, maintained by Kela, for the purposes of spreading information of
existing implementations of this resource type. Do pay attention to the validation messages in the
[QA report](qa.html) of this implementation guide, before using this example. Also please track the
[Kanta FHIR Prescription R4](https://simplifier.net/prescriptionr4) implementation guide for any
changes in examples.
7 changes: 7 additions & 0 deletions input/includes/fragment-kanta-phr-warning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{:.dragon}
This example does not validate properly in the context of this implementation guide. It has been
imported from an implementation guide for Kanta PHR system, maintained by Kela, for the purposes of
spreading information of existing implementations of this resource type. Do pay attention to the
validation messages in the [QA report](qa.html) of this implementation guide, before using this
example. Also please track the [Finnish PHR R4](https://simplifier.net/finnishphrr4) implementation
guide for any changes in examples.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{:.dragon}
This example refers to extensions defined in another implementation guide, the
[FinnishScheduling R4](https://simplifier.net/finnishschedulingr4/) IG, and has errors in the
[QA Report](qa.html) for this guide. The schedulinig IG is about to be updadted and the
canonical urls defined for the extensions may change, at least to have a `https` protocol instead
of `http`.
16 changes: 16 additions & 0 deletions input/pagecontent/Bundle-diabetes-data-bundle-kantaphr-sv-intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
This example uses the older
[STU3 profile](https://simplifier.net/finnishphr/fiphr-sd-bloodglucose-stu3) of the Finnish PHR.

{:.dragon}
The example does not validate properly in the context of this implementation guide. Do pay
attention to the validation messages in the [QA report](qa.html) of this implementation guide,
before using this example.

The example uses a customized `display` value in `valueCodeableConcept.coding.display`, as mandated
by Kela (see the
[Narrative guide](https://simplifier.net/guide/FinnishPHRImplementationGuideSTU5/FinnishPHRVitalSignsProfiles?version=current#narrative-guide)
and the [customized localizations](https://simplifier.net/finnishphr/fiphr-vs-vitalsigns)).

The example also refers to the code system `http://hl7.org/fhir/observation-category`
[mandated by the profile](https://simplifier.net/finnishphr/fiphr-sd-bloodglucose-stu3). That
system does not resolve.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include fragment-kanta-meds-warning.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include fragment-kanta-meds-warning.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include fragment-kanta-meds-warning.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include fragment-kanta-meds-warning.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include fragment-kanta-meds-warning.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include fragment-kanta-meds-warning.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include fragment-kanta-meds-warning.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include fragment-kanta-meds-warning.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include fragment-kanta-meds-warning.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include fragment-kanta-meds-warning.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{% include fragment-kanta-phr-warning.md %}

The example uses a customized `display` value in `valueCodeableConcept.coding.display`. If you want
to customize the display of a known code (such as the LOINC codes in this case), you should use the
`valueCodeableConcept.text` property instead.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{% include fragment-kanta-phr-warning.md %}

The example uses a customized `display` value in `valueCodeableConcept.coding.display`. If you want
to customize the display of a known code (such as the LOINC codes in this case), you should use the
`valueCodeableConcept.text` property instead.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{% include fragment-kanta-phr-warning.md %}

The example uses a customized `display` value in `valueCodeableConcept.coding.display`. If you want
to customize the display of a known code (such as the LOINC codes in this case), you should use the
`valueCodeableConcept.text` property instead.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{% include fragment-kanta-phr-warning.md %}

The example uses a customized `display` value in `valueCodeableConcept.coding.display`. If you want
to customize the display of a known code (such as the LOINC codes in this case), you should use the
`valueCodeableConcept.text` property instead.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{% include fragment-kanta-phr-warning.md %}

The example uses a customized `display` value in `valueCodeableConcept.coding.display`. If you want
to customize the display of a known code (such as the LOINC codes in this case), you should use the
`valueCodeableConcept.text` property instead.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{% include fragment-kanta-phr-warning.md %}

The example uses a customized `display` value in `valueCodeableConcept.coding.display`. If you want
to customize the display of a known code (such as the LOINC codes in this case), you should use the
`valueCodeableConcept.text` property instead.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include fragment-kanta-phr-warning.md %}
3 changes: 3 additions & 0 deletions input/pagecontent/Observation-bloodglucose-max-intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{% include fragment-kanta-phr-warning.md %}

Also note that the narrative does not seem to present what is actually in the resource.
5 changes: 5 additions & 0 deletions input/pagecontent/Observation-bloodglucose-min-intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{% include fragment-kanta-phr-warning.md %}

The example uses a customized `display` value in `valueCodeableConcept.coding.display`. If you want
to customize the display of a known code (such as the LOINC codes in this case), you should use the
`valueCodeableConcept.text` property instead.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{% include fragment-kanta-phr-warning.md %}

The
5 changes: 5 additions & 0 deletions input/pagecontent/Observation-mtvpa-max-intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{% include fragment-kanta-phr-warning.md %}

The example uses a customized `display` value in `valueCodeableConcept.coding.display`. If you want
to customize the display of a known code (such as the LOINC codes in this case), you should use the
`valueCodeableConcept.text` property instead.
5 changes: 5 additions & 0 deletions input/pagecontent/Observation-mtvpa-min-intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{% include fragment-kanta-phr-warning.md %}

The example uses a customized `display` value in `valueCodeableConcept.coding.display`. If you want
to customize the display of a known code (such as the LOINC codes in this case), you should use the
`valueCodeableConcept.text` property instead.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{:.dragon}
This example is from a live system. It does not follow the best practice recommendation from IPA
that the name should have the `.text` element populated. Also the identifier type `MNEMONIC` is not
recognized in the context of this implementation guide.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{:.dragon}
This example is intentionally built to not pass validation, and included in the implementation
guide to show that resource validation works in the expected way using the `imposesProfile`
extension.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{:.dragon}
This example is intentionally built to not pass validation, and included in the implementation
guide to show that resource validation works in the expected way using the `imposesProfile`
extension.
1 change: 1 addition & 0 deletions sushi-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,7 @@ pages:

parameters:
ipa-comparison: "{last}" # "{current}" | "{last}"
extension-domain: [ http://hl7.fi/, http://phr.kanta.fi/, http://resepti.kanta.fi/ ]

menu:
Home: index.html
Expand Down

0 comments on commit fdcbde8

Please sign in to comment.