Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Escape characters in markdown comments #444

Merged
merged 3 commits into from
Apr 19, 2024
Merged

Escape characters in markdown comments #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1bec442
Escape characters in markdown comments
LuudSlagter Apr 17, 2024
5dba6b8
Put all cardinalities between backticks
LuudSlagter Apr 18, 2024
1c420b2
Put remaining cardinality between backticks
LuudSlagter Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,19 @@ This document contains release notes per zib, indicating differences with their
* Added constraints in the profile on the choice that the zib provides between Concern and AlertName. Added guidance on which code to add to `Flag.code` if a reference to Concern is added.

## zib-AdvanceDirective
* Moved TypeOfLivingWill from `Consent.category` to `Consent.provision.code`, renamed it to LivingWillType in accordance with the zib and made the element 0..1 rather than 1..1 to adhere to the conceptual cardinalities of the zib.
* Moved TypeOfLivingWill from `Consent.category` to `Consent.provision.code`, renamed it to LivingWillType in accordance with the zib and made the element `0..1` rather than `1..1` to adhere to the conceptual cardinalities of the zib.
* Moved LivingWillDocument from `Consent.source[x]` to `Consent.source[x]:sourceAttachment.data`.
* Moved Representative from `Consent.consentingParty` to `Consent.provision.actor:representative.reference` because the element is removed in R4. Also `Consent.provision.actor:representative.role` has now a fixed value for this mapping.
* Replaced fixed zib code 11341000146107#http://snomed.info/sct on `Consent.category` with acd#http://terminology.hl7.org/CodeSystem/consentcategorycodes because this is an applicable code bound in the extensible ValueSet.
* Removed references that are not defined by the zib (e.g. `Consent.organization` and `Consent.actor`).
* Adjusted the `Consent.dateTime` cardinality from 1..1 to 0..1 to adhere to the conceptual cardinalities of the zib.
* Adjusted the `Consent.dateTime` cardinality from `1..1` to `0..1` to adhere to the conceptual cardinalities of the zib.
* Added guidance for mandatory elements `Consent.status`,`Consent.scope` and `Consent.policy` or `Consent.policyRule`.

# zib-AllergyIntolerance
* Applied 'combined ValueSets' to `.code` and `.reaction.substance` instead of slicing per ValueSet.
* The code-specification extensions have been removed from `.clinicalStatus` and `.reaction.severity` because the zib concepts can be fully mapped to FHIR.
* Because AlleryStatus maps to both `.clinicalStatus` and `.verificationStatus`, but `.verificationStatus` now has cardinality 0..1 compared to 1..1 in STU3, guidance on how to interpret the mapping has been added to the root, but has been simplified.
* Changed cardinality of `.note` from 0..* to 0..1 to align with the zib.
* Because AlleryStatus maps to both `.clinicalStatus` and `.verificationStatus`, but `.verificationStatus` now has cardinality `0..1` compared to `1..1` in STU3, guidance on how to interpret the mapping has been added to the root, but has been simplified.
* Changed cardinality of `.note` from `0..*` to `0..1` to align with the zib.

## zib-AnatomicalLocation
* New partial zib. The anatomical location in FHIR is usually mapped on `.bodySite` (CodeableConcept with example binding). This zib has therefore been mapped onto a data type profile that can be used for `.bodySite`.
Expand Down Expand Up @@ -106,7 +106,7 @@ This document contains release notes per zib, indicating differences with their

## zib-ContactPerson
* Added textual guidance on the root to guide usage of RelatedPerson versus Patient.
* Removed the role extension (http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role) because `RelatedPerson.relationship` has changed from 0..1 to 0..*. The zib concept role is now mapped to a slice on relationship.
* Removed the role extension (http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role) because `RelatedPerson.relationship` has changed from `0..1` to `0..*`. The zib concept role is now mapped to a slice on relationship.
* Updated to new zib-NameInformation, zib-AddressInformation and zib-ContactInformation profiles.

## zib-DevelopmentChild
Expand All @@ -125,7 +125,7 @@ This document contains release notes per zib, indicating differences with their
## zib-Encounter
* ContactWith is mapped on a slice of `Encounter.participant`.
* `Encounter.participant.type` now honors the maximum cardinality of HealthProfessionalRole.
* `Encounter.period.start` changed to cardinality 0..1 due to the zibs conceptual cardinalities concept.
* `Encounter.period.start` changed to cardinality `0..1` due to the zibs conceptual cardinalities concept.
* The mapping of concepts Problem, Procedure and DeviatingResult is moved to `Encounter.reasonReference`.
* The mapping of Location is moved to `Encounter.location.location`.
* References to other profiles not accounted for by the zib have been removed.
Expand Down Expand Up @@ -165,14 +165,14 @@ This document contains release notes per zib, indicating differences with their

## zib-HealthcareProvider
* `Organization.identifier` is now sliced based on a pattern.
* Changed cardinality of `Organization.type[DepartmentSpecialty]` and `Organization.type[OrganizationType]` from 0..* to 0..1.
* Changed cardinality of `Organization.type[DepartmentSpecialty]` and `Organization.type[OrganizationType]` from `0..*` to `0..1`.
* For `Organization.type` the slicing discriminator is changed from fixed system values to a ValueSet binding.
* Removed comments on `Organization.alias` because it has no basis in the zib.
* Added comments on the root to point out the usage of the Location resource and the `Organization.partOf`.
* Major change: use of Location resource.

## zib-HealthProfessional
* `Practitioner.identifier` slices changed cardinality from 0..1 to 0..*.
* `Practitioner.identifier` slices changed cardinality from `0..1` to `0..*`.
* Added HealthProfessionalIdentificationNumber mapping on `PractitionerRole.identifier`.
* Added new mapping of Gender in Practitioner.
* Added textual guidance on the root to clarify the use of Practitioner and PractitionerRole.
Expand All @@ -182,7 +182,7 @@ This document contains release notes per zib, indicating differences with their

## zib-HearingFunction
* Changed fixed slice on `.code.coding` to a pattern on `.code`.
* Relaxed cardinality of `.value[x]` to 0..1 of the conceptual cardinalities of the zib.
* Relaxed cardinality of `.value[x]` to `0..1` of the conceptual cardinalities of the zib.

## zib-HelpFromOthers
* The mappings on `CarePlan.identifier`, `CarePlan.subject`, `CarePlan.author` and `CarePlan.careTeam` have been removed.
Expand Down Expand Up @@ -256,17 +256,17 @@ This document contains release notes per zib, indicating differences with their
## zib-PainScore
* Removed mapping on `Observation.bodySite` because the AnatomicalLocation concept has been removed from the zib.
* Removed laterality extension because the Laterality concept has been removed from the zib.
* Cardinality of `Observation.method` has changed from 1..1 to 0..1.
* Cardinality of `Observation.method` has changed from `1..1` to `0..1`.
* The data type of `Observation.value[x]` (zib concept PainScoreValue) has been changed from Quantity to Integer.

## zib-ParticipationInSociety
* No specific changes have been made to this profile other than the generic changes for the Observation resource

## zib-Patient
* Includes Nationality, MaritalStatus, LanguageProficiency.
* Cardinality of `Patient.extension:nationality` left at 0..* due to the nature of the nationality core extension (which allows for a period to be placed next to the nationality and thus allows for different nationalities over time).
* Cardinality of `Patient.name` left at 0..* to allow including several name elements with a different `name.use` each.
* Cardinality of `Patient.telecom` left at 0..* to allow including several contact elements, because the zib ContactInformation includes a container that FHIR does not.
* Cardinality of `Patient.extension:nationality` left at `0..*` due to the nature of the nationality core extension (which allows for a period to be placed next to the nationality and thus allows for different nationalities over time).
* Cardinality of `Patient.name` left at `0..*` to allow including several name elements with a different `name.use` each.
* Cardinality of `Patient.telecom` left at `0..*` to allow including several contact elements, because the zib ContactInformation includes a container that FHIR does not.
* Added a comment to `deceased[x]`: When exporting the data, if `.deceasedDateTime` (DateOfDeath) is present and has a value, DeathIndicator may be set to 'true', since DeathIndicator and DateOfDeath cannot both be represented at the same time.

## zib-Payer
Expand Down Expand Up @@ -311,8 +311,8 @@ This document contains release notes per zib, indicating differences with their
## Procedure
* Renamed profiles from zib-Procedure and zib-ProcedureRequest to zib-Procedure-event and zib-Procedure-request conform profiling guidelines.
* ProcedureStartDate and ProcedureEndDate have been mapped to `Procedure.performed[x]` instead of `Procedure.performedPeriod` to account for the use of `Procedure.performedDateTime` when the zib Procedure concerns an instantaneous procedure.
* Changed cardinality of the ProcedureMethod concept to 0..* instead of 0..1.
* The ProcedureAnatomicalLocation is mapped on `Procedure.bodySite` and the cardinality has been set to 0..1 instead of 0..*.
* Changed cardinality of the ProcedureMethod concept to `0..*` instead of `0..1`.
* The ProcedureAnatomicalLocation is mapped on `Procedure.bodySite` and the cardinality has been set to `0..1` instead of `0..*`.
* The resource ProcedureRequest has been renamed to ServiceRequest and now includes a mapping for all the possible concepts of zib Procedure. Compared to STU3 a mapping has been added for ProcedureMethod, ProcedureAnatomicalLocation, MedicalDevice, ProcedureStartDate and ProcedureEndDate.
* `Procedure.location` and `ServiceRequest.locationReference` are used to reference the zib HealthcareProvider instead of `Procedure.performer` and `ProcedureRequest.performer` to indicate where the Procedure takes place.
* The `Procedure.performer` only references the zib HealthProfessional represented in a PractitionerRole resource. Other references not dictated by the zib are removed.
Expand Down Expand Up @@ -378,7 +378,7 @@ This document contains release notes per zib, indicating differences with their
## zib-Vaccination
* Renamed profile names: zib-Vaccination to zib-Vaccination-event and zib-VaccinationRecommendation to zib-Vaccination-request conform new profiling guidelines.
* Removed references not accounted for by the zib (e.g. `Immunization.location`, `Immunization.manufacturer` and `ImmunizationRecommendation.recommendation.supportingImmunization`).
* Aligned cardinality of `Immunization.note` with the zib by making it 0..1.
* Aligned cardinality of `Immunization.note` with the zib by making it `0..1`.
* Moved VaccinationDate on a type slice on `Immunization.occurrence[x]:occurrenceDateTime`. This element has been renamed from `date` to `occurrence[x]` in R4.
* Moved Administrator to a slice on `Immunization.performer` with a mandatory fixed pattern in `Immunization.performer.function`.
* Added a pattern on `Immunization.doseQuantity` to mandate the use of mL by UCUM because the definition of Dose states to use milliliters.
Expand All @@ -388,4 +388,4 @@ This document contains release notes per zib, indicating differences with their

## zib-VisualFunction
* Changed fixed slice on `.code.coding` to a pattern on `.code`.
* Relaxed cardinality of `value[x]` to 0..1 of the conceptual cardinalities of the zib.
* Relaxed cardinality of `value[x]` to `0..1` of the conceptual cardinalities of the zib.
2 changes: 1 addition & 1 deletion resources/nl-core/ext-AdditionalCategory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<use value="work" />
</telecom>
</contact>
<description value="An extension that mimics the default FHIR `Resource.category` element that can be used if multiple categories need to be captured, while the cardinality of the core element is 0..1. Resource types where this is the case are for example MedicationAdministration, MedicationDispense, MedicationStatement and Procedure. Note that in the current FHIR R5 build of these resource types, the cardinality of `.category` has been changed to 0..*." />
<description value="An extension that mimics the default FHIR `Resource.category` element that can be used if multiple categories need to be captured, while the cardinality of the core element is `0..1`. Resource types where this is the case are for example MedicationAdministration, MedicationDispense, MedicationStatement and Procedure. Note that in the current FHIR R5 build of these resource types, the cardinality of `.category` has been changed to `0..*`." />
<purpose value="In addition to using this extension, a binding should be added to `extension.valueCodeableConcept` referring to the ValueSet of its respective resource type category and with a binding strength that matches the FHIR core binding strength, along with an appropriate definition and short." />
<copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
<fhirVersion value="4.0.1" />
Expand Down
2 changes: 1 addition & 1 deletion resources/nl-core/ext-Context-EpisodeOfCare.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<use value="work" />
</telecom>
</contact>
<description value="`Observation.context` and `MedicationRequest.context` have been renamed and remodeled in R4 to only contain a reference to Encounter. `MedicationStatement.context` and `MedicationAdministration.context` are a 0..1 reference to Encounter|EpisodeOfCare. This extension allows to add a reference to EpisodeOfCare (potentially next to a reference to an Encounter). From R5 onwards, this extension will likely be replaced by an HL7 core extension." />
<description value="`Observation.context` and `MedicationRequest.context` have been renamed and remodeled in R4 to only contain a reference to Encounter. `MedicationStatement.context` and `MedicationAdministration.context` are a `0..1` reference to Encounter|EpisodeOfCare. This extension allows to add a reference to EpisodeOfCare (potentially next to a reference to an Encounter). From R5 onwards, this extension will likely be replaced by an HL7 core extension." />
<purpose value="This extension provides a generic method to add a reference to an EpisodeOfCare resource." />
<copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
<fhirVersion value="4.0.1" />
Expand Down
2 changes: 1 addition & 1 deletion resources/nl-core/nl-core-HealthProfessional-PractitionerRole.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
</element>
<element id="PractitionerRole.organization">
<path value="PractitionerRole.organization" />
<comment value="A HealthcareProvider in zib terms is primarily a location where care is provided, and so the zib concept HealthcareProvider (NL-CM:17.1.6) would normally be fulfilled using a reference to a Location resource (profile nl-core-HealthcareProvider). However, this particular context refers to the organizational aspects of a HealthcareProvider rather than its physical location:&#xD;&#xA;* the zib concept name is not preceded by a role indicator of the zib (like Location::HealthcareProvider, concept id NL-CM:14.1.5, in the zib Procedure).&#xD;&#xA;* the `PractitionerRole.location` cardinality (0..*) does not match the zib concept (0..1) and restricting it is not correct as a health professional could be working on multiple locations.&#xD;&#xA;&#xD;&#xA;Therefore, this concept is fulfilled using a reference to the Organization resource (profile nl-core-HealthcareProvider-Organization) and mapped onto `PractitionerRole.organization` instead of `PractitionerRole.location`." />
<comment value="A HealthcareProvider in zib terms is primarily a location where care is provided, and so the zib concept HealthcareProvider (NL-CM:17.1.6) would normally be fulfilled using a reference to a Location resource (profile nl-core-HealthcareProvider). However, this particular context refers to the organizational aspects of a HealthcareProvider rather than its physical location:&#xD;&#xA;* the zib concept name is not preceded by a role indicator of the zib (like Location::HealthcareProvider, concept id NL-CM:14.1.5, in the zib Procedure).&#xD;&#xA;* the `PractitionerRole.location` cardinality (`0..*`) does not match the zib concept (`0..1`) and restricting it is not correct as a health professional could be working on multiple locations.&#xD;&#xA;&#xD;&#xA;Therefore, this concept is fulfilled using a reference to the Organization resource (profile nl-core-HealthcareProvider-Organization) and mapped onto `PractitionerRole.organization` instead of `PractitionerRole.location`." />
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
Expand Down
2 changes: 1 addition & 1 deletion resources/nl-core/nl-core-Procedure-request.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
</element>
<element id="ServiceRequest.requester">
<path value="ServiceRequest.requester" />
<comment value="The zib mapping contains a known cardinality difference (0..* versus 0..1). The zib will be aligned in a future version with the cardinality of FHIR, therefore this profile pre-adopts the 0..1 cardinality for the requester.&#xD;&#xA;&#xD;&#xA;Each occurrence of the zib HealthProfessional is normally represented by _two_ FHIR resources: a PractitionerRole resource (instance of [nl-core-HealthProfessional-PractitionerRole](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole)) and a Practitioner resource (instance of [nl-core-HealthProfessional-Practitioner](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner)). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.&#xD;&#xA;&#xD;&#xA;In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the zib-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile." />
<comment value="The zib mapping contains a known cardinality difference (`0..*` versus `0..1`). The zib will be aligned in a future version with the cardinality of FHIR, therefore this profile pre-adopts the `0..1` cardinality for the requester.&#xD;&#xA;&#xD;&#xA;Each occurrence of the zib HealthProfessional is normally represented by _two_ FHIR resources: a PractitionerRole resource (instance of [nl-core-HealthProfessional-PractitionerRole](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole)) and a Practitioner resource (instance of [nl-core-HealthProfessional-Practitioner](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner)). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.&#xD;&#xA;&#xD;&#xA;In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the zib-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile." />
<type>
<code value="Reference" />
<profile value="http://nictiz.nl/fhir/StructureDefinition/pattern-NlCoreHealthProfessionalReference" />
Expand Down
Loading
Loading