Da Vinci Unsolicited Notifications Implementation Guide (Release 0.2.0 STU1 Ballot)

This page is part of the Da Vinci Unsolicited Notifications (v0.2.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition-notifications-graphdefinition

The Da Vinci Notifications GraphDefinition Profile adds the capability to set “mustSupport” expectectations for links in the FHIR GraphDefinition resource to define usage conformance in an implementation specific manner. This extension is used in the similar way as the ElementDefinition.mustSupport in the FHIR specification.

Mandatory and Must Support Data Elements

The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each GraphDefinition must support:

  1. The Da Vinci Notifications Must Support Extension

Examples

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/notifications-graphdefinition

Published on Thu Nov 14 00:00:00 UTC 2019 as active by the Health eData Inc.

This profile builds on GraphDefinition

GraphDefinition

Summary of the Must Support Requirements

  1. One or more Links in GraphDefinition.link
    • which should have at least a Must-Support Extension value in GraphDefinition.link.extension

Summary of Constraints

  1. Name should be usable as an identifier for the module by machine processing applications such as code generation
NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition I0..*GraphDefinitionDefinition of a graph of resources
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI0..1uriCanonical identifier for this graph definition, represented as a URI (globally unique)
... version ΣI0..1stringBusiness version of the graph definition
... name ΣI1..1stringName for this graph definition (computer friendly)
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ΣI0..1booleanFor testing purposes, not real usage
... date ΣI0..1dateTimeDate last changed
... publisher ΣI0..1stringName of the publisher (organization or individual)
... contact ΣI0..*ContactDetailContact details for the publisher
... description I0..1markdownNatural language description of the graph definition
... useContext ΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣI0..*CodeableConceptIntended jurisdiction for graph definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose I0..1markdownWhy this graph definition is defined
... start ΣI1..1codeType of resource at which the graph starts
Binding: ResourceType (required)
... profile I0..1canonical(StructureDefinition)Profile on base resource
... link SI0..*BackboneElementLinks this graph makes rules about
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-mustSupport SI0..1booleanIf the link must be supported
URL: http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/extension-mustSupport
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path I0..1stringPath in the resource that contains the link
.... sliceName I0..1stringWhich slice (if profiled)
.... min I0..1integerMinimum occurrences for this link
.... max I0..1stringMaximum occurrences for this link
.... description I0..1stringWhy this link is specified
.... target I0..*BackboneElementPotential target for the link
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type I1..1codeType of resource this link refers to
Binding: ResourceType (required)
..... params I0..1stringCriteria for reverse lookup
..... profile I0..1canonical(StructureDefinition)Profile for the target resource
..... compartment I0..*BackboneElementCompartment Consistency Rules
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... use I1..1codecondition | requirement
Binding: GraphCompartmentUse (required)
...... code I1..1codePatient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required)
...... rule I1..1codeidentical | matching | different | custom
Binding: GraphCompartmentRule (required)
...... expression I0..1stringCustom rule, as a FHIRPath expression
...... description I0..1stringDocumentation for FHIRPath expression
..... link I0..*Unknown reference to #GraphDefinition.link
Additional links from target resource

doco Documentation for this format

GraphDefinition

Summary of the Must Support Requirements

  1. One or more Links in GraphDefinition.link
    • which should have at least a Must-Support Extension value in GraphDefinition.link.extension

Summary of Constraints

  1. Name should be usable as an identifier for the module by machine processing applications such as code generation

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition I0..*GraphDefinitionDefinition of a graph of resources
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI0..1uriCanonical identifier for this graph definition, represented as a URI (globally unique)
... version ΣI0..1stringBusiness version of the graph definition
... name ΣI1..1stringName for this graph definition (computer friendly)
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ΣI0..1booleanFor testing purposes, not real usage
... date ΣI0..1dateTimeDate last changed
... publisher ΣI0..1stringName of the publisher (organization or individual)
... contact ΣI0..*ContactDetailContact details for the publisher
... description I0..1markdownNatural language description of the graph definition
... useContext ΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣI0..*CodeableConceptIntended jurisdiction for graph definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose I0..1markdownWhy this graph definition is defined
... start ΣI1..1codeType of resource at which the graph starts
Binding: ResourceType (required)
... profile I0..1canonical(StructureDefinition)Profile on base resource
... link SI0..*BackboneElementLinks this graph makes rules about
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-mustSupport SI0..1booleanIf the link must be supported
URL: http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/extension-mustSupport
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path I0..1stringPath in the resource that contains the link
.... sliceName I0..1stringWhich slice (if profiled)
.... min I0..1integerMinimum occurrences for this link
.... max I0..1stringMaximum occurrences for this link
.... description I0..1stringWhy this link is specified
.... target I0..*BackboneElementPotential target for the link
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type I1..1codeType of resource this link refers to
Binding: ResourceType (required)
..... params I0..1stringCriteria for reverse lookup
..... profile I0..1canonical(StructureDefinition)Profile for the target resource
..... compartment I0..*BackboneElementCompartment Consistency Rules
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... use I1..1codecondition | requirement
Binding: GraphCompartmentUse (required)
...... code I1..1codePatient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required)
...... rule I1..1codeidentical | matching | different | custom
Binding: GraphCompartmentRule (required)
...... expression I0..1stringCustom rule, as a FHIRPath expression
...... description I0..1stringDocumentation for FHIRPath expression
..... link I0..*Unknown reference to #GraphDefinition.link
Additional links from target resource

doco Documentation for this format

See the Conformance requirements for a complete list of supported RESTful interactions for this IG.