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.

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

Add a minimal ShareableViewDefinition profile. #224

Merged
merged 1 commit into from
Mar 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions input/fsh/models.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,13 @@ criteria are defined by FHIRPath expressions.
Name of the view definition, must be in a database-friendly format.
"""
* name obeys sql-name
* version 0..1 string "Business version of the view definition"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed a couple things since they are redundant with the Meta structure content

* title 0..1 string "Name for this view definition (human friendly)" """
A optional human-readable description of the view.
"""
* meta 0..1 Meta "Metadata about the view definition"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this so ViewDefinitions can specify their profiles the same way as resources do.

* status 1..1 code "draft | active | retired | unknown"
* status from http://hl7.org/fhir/ValueSet/publication-status
* experimental 0..1 boolean "For testing purposes, not real usage"
* date 0..1 dateTime "Date last changed"
* publisher 0..1 string "Name of the publisher/steward (organization or individual)"
* contact 0..* ContactDetail "Contact details for the publisher"
* description 0..1 markdown "Natural language description of the view definition"
Expand Down
7 changes: 7 additions & 0 deletions input/fsh/profiles.fsh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Profile: ShareableViewDefinition
Parent: ViewDefinition
Description: "A Shareable View Definition"
* url 1..1
* name 1..1
* fhirVersion 1..*
* select.column.type 1..1
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
A profile of [View Definition](StructureDefinition-ViewDefinition.html) for views that are intended
to be shared across organizations. It adds constraints to the base definition, such as requiring a URL, name, and types for each
column. See the differential table below for details.
4 changes: 4 additions & 0 deletions input/pagecontent/StructureDefinition-ViewDefinition-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,7 @@ A system-specific *view runner* implementation can execute a *view definition* a
return the results as a table that can easily be used in the user's tech stack. See the
[system layers](index.html#system-layers) for details.

## Profiling
ViewDefinitions may be profiled to meet specific needs. For instance, the [ShareableViewDefinition](StructureDefinition-ShareableViewDefinition.html) profile
adds constraints for view definitions intended to be shared between systems. Implementers may create their
own ViewDefinition profiles for further specialized needs.
1 change: 1 addition & 0 deletions sushi-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ menu:
Purpose: purpose.html
View Definition: StructureDefinition-ViewDefinition.html
Implementer Guidance: implementer_guidance.html
Artifacts: artifacts.html
Contributing: contributing.html

# ╭───────────────────────────Less Common Implementation Guide Properties──────────────────────────╮
Expand Down
Loading