Skip to content

Issue 144 obligations #182

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

Merged
MariekeMassa merged 5 commits into from
Aug 4, 2026
Merged

Issue 144 obligations #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fe2b1d5
#144 Add must support to obligations
MariekeMassa Jul 31, 2026
878b5df
Remove obligation from recipient in communicationrequest
MariekeMassa Jul 31, 2026
c35261f
Create example for preferred place of death - other
MariekeMassa Aug 2, 2026
f0bab4b
Add mustSupport to obligation explanation on data model page
MariekeMassa Aug 2, 2026
f7cc4b2
Small update in data model description and restoring old example
MariekeMassa Aug 4, 2026
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
1 change: 0 additions & 1 deletion input/fsh/CommunicationRequest.fsh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ Description: "A CommunicationRequest representing the advice or instruction give
* insert ObligationRules(authoredOn) // not explicitly required/defined in dataset but important for context
* insert ObligationRules(requester)
* insert ObligationRules(sender)
* insert ObligationRules(recipient)
* insert ObligationRules(reasonCode) // already 1..1 so may not be needed place under obligation but added for consistency


Expand Down
4 changes: 2 additions & 2 deletions input/fsh/Observation.fsh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ Usage: #example

Instance: ACP-PreferredPlaceOfDeath-Pat2
InstanceOf: ACPPreferredPlaceOfDeath
Title: "ACP Preferred Place Of Death - Pat 2"
Title: "ACP Preferred Place of Death - Pat 2"
Usage: #example
* identifier.type = $v2-0203#RI "Resource identifier"
* identifier.system = "https://acme.com/fhir/NamingSystem/resource-business-identifier"
Expand Down Expand Up @@ -270,7 +270,7 @@ Usage: #example

Instance: ACP-OrganDonationChoiceRegistrationInDonorRegister-Pat2
InstanceOf: ACPOrganDonationChoiceRegistration
Title: "ACP Organ Donation Choice Registration In Donor Register - Pat 2"
Title: "ACP Organ Donation Choice Registration in Donor Register - Pat 2"
Usage: #example
* identifier.type = $v2-0203#RI "Resource identifier"
* identifier.system = "https://acme.com/fhir/NamingSystem/resource-business-identifier"
Expand Down
1 change: 1 addition & 0 deletions input/fsh/RuleSet.fsh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ RuleSet: CapabilityStatementSearchParmeterClinicalPatientExpectation
* type = #reference

RuleSet: ObligationRules(path)
* {path} MS
* {path} ^extension[$obligation][+].extension[code].valueCode = #SHALL:populate-if-known
* {path} ^extension[$obligation][=].extension[actor].valueCanonical = Canonical(ACPActorProvider)
* {path} ^extension[$obligation][+].extension[code].valueCode = #SHALL:no-error
Expand Down
8 changes: 4 additions & 4 deletions input/pagecontent/data-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ The FHIR profiles in this guide are directly linked to the ACP dataset elements

Each StructureDefinition includes a `StructureDefinition.mapping.uri` that points to the specific version of the ACP dataset used. Additionally, every element within a profile is individually mapped to its corresponding dataset element using the `ElementDefinition.mapping` property. The mapping table below shows all mappings in one view, while the "Mappings" tab of each profile page displays the mappings consolidated per profile. These mappings provide a straightforward way to highlight the elements that are especially relevant for the ACP use case.

#### Obligation flags
To indicate which elements are essential for the ACP use case, <a href="https://hl7.org/fhir/extensions/StructureDefinition-obligation.html">Obligation flags</a> have been added to all elements mapped to the ACP dataset. These flags are visible in the formal profile views.
#### MustSupport and Obligation flags
To indicate which elements are essential for the ACP use case and for which implementations must thus provide support, `mustSupport` flags are placed on all elements mapped to the ACP dataset. For clarification of the expectations associated with these `mustSupport` labels, the <a href="https://hl7.org/fhir/extensions/StructureDefinition-obligation.html">`obligation` element</a> is used.

In this version of the IG, Obligation flags are applied to all mapped elements, regardless of whether the dataset element is mandatory or optional. The obligations are defined for the following actors:
In this version of the IG, `mustSupport` and `obligation` flags are applied to all mapped elements, regardless of whether the dataset element is mandatory or optional. The `obligations` are defined for the following actors:
* <a href="ActorDefinition-ACPActorProvider.html">ACP Actor Provider</a>: `SHALL:populate-if-known`
* <a href="ActorDefinition-ACPActorConsulter.html">ACP Actor Consulter</a>: `SHALL:no-error`

In future versions of the IG, these obligations may be refined on a per-element basis.
In future versions of the IG, these `obligations` may be refined on a per-element basis.

#### Note on referenced zibs

Expand Down
Loading