Da Vinci Alerts Implementation Guide (Release 0.1.0 STU1 Ballot)

This page is part of the Da Vinci Unsolicited Notifications (v1.0.0: STU1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition-alerts-endpoint

The Da Vinci Alerts Endpoint Profile MAY be exchanged as part of an alert notifications. The Endpoint contains the technical details of an endpoint for getting additional information from the medical record for the event. This profile sets minimum expectations for the Endpoint resource to record the necessary context for the alert notifications. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the Endpoint resource.

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 Endpoint must have:

  1. a status
  2. a connectionType of hl7-fhir-rest
  3. a payloadType text only value of “n/a”
  4. An endpoint address

Each Endpoint must support:

  1. one or more header strings*

Additional Profile specific implementation guidance:

  • An endpoint supplied in this profile may be different or same as the endpoint that may be obtained from Communication.sender references: Organization or PractitionerRole.
  • *An authentication token may be supplied in Endpoint.header by the Alert Sender to allow direct recipients of the Alert (whether an Alert Recipient or Alert Intermediary) to access additional information. This and other supplied headers, if any are given, are appended to the GET request. Sending these tokens has obvious security consequences. The server and client are responsible for ensuring that the content is appropriately secured.

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/alerts-endpoint

Published on Mon Jul 22 00:00:00 EDT 2019 as active by the Health eData Inc.

This profile builds on Endpoint

Endpoint

Summary of the Mandatory Requirements

  1. A code in Endpoint.status with a required binding to EndpointStatus
  2. A Coding in Endpoint.connectionType with an extensible binding to Endpoint Connection Type
    • which must have a fixed Endpoint.connectionType.system = http://terminology.hl7.org/CodeSystem/endpoint-connection-type
    • which must have a fixed Endpoint.connectionType.code = hl7-fhir-rest
  3. A CodeableConcept in Endpoint.payloadType
    • which must have no Coding values in Endpoint.payloadType.coding
    • which must have a string value in Endpoint.payloadType.text = ‘n/a’
  4. An url in Endpoint.address

Summary of the Must Support Requirements

  1. One or more strings in Endpoint.header
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*
... status S1..1code
... connectionType S1..1Coding
.... system S1..1uriFixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type
.... code S1..1codeFixed Value: hl7-fhir-rest
... payloadType S1..1CodeableConcept
.... coding S0..0
.... text S1..1stringFixed Value: n/a
... address S1..1url
... header S0..*string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint I0..*The technical details of an endpoint that can be used for electronic services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifies this endpoint across multiple systems
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required)
... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type
.... version Σ0..1stringVersion of the system - if relevant
.... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: hl7-fhir-rest
.... display Σ0..1stringRepresentation defined by the system
.... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... name Σ0..1stringA name that this endpoint can be identified by
... managingOrganization Σ0..1Reference(Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..*ContactPointContact details for source (e.g. troubleshooting)
... period Σ0..1PeriodInterval the endpoint is expected to be operational
... payloadType SΣ1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... text SΣ1..1stringPlain text representation of the concept
Fixed Value: n/a
... payloadMimeType Σ0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required)
... address SΣ1..1urlThe technical base address for connecting to this endpoint
... header S0..*stringUsage depends on the channel type

doco Documentation for this format

Endpoint

Summary of the Mandatory Requirements

  1. A code in Endpoint.status with a required binding to EndpointStatus
  2. A Coding in Endpoint.connectionType with an extensible binding to Endpoint Connection Type
    • which must have a fixed Endpoint.connectionType.system = http://terminology.hl7.org/CodeSystem/endpoint-connection-type
    • which must have a fixed Endpoint.connectionType.code = hl7-fhir-rest
  3. A CodeableConcept in Endpoint.payloadType
    • which must have no Coding values in Endpoint.payloadType.coding
    • which must have a string value in Endpoint.payloadType.text = ‘n/a’
  4. An url in Endpoint.address

Summary of the Must Support Requirements

  1. One or more strings in Endpoint.header

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*
... status S1..1code
... connectionType S1..1Coding
.... system S1..1uriFixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type
.... code S1..1codeFixed Value: hl7-fhir-rest
... payloadType S1..1CodeableConcept
.... coding S0..0
.... text S1..1stringFixed Value: n/a
... address S1..1url
... header S0..*string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint I0..*The technical details of an endpoint that can be used for electronic services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifies this endpoint across multiple systems
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required)
... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type
.... version Σ0..1stringVersion of the system - if relevant
.... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: hl7-fhir-rest
.... display Σ0..1stringRepresentation defined by the system
.... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... name Σ0..1stringA name that this endpoint can be identified by
... managingOrganization Σ0..1Reference(Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..*ContactPointContact details for source (e.g. troubleshooting)
... period Σ0..1PeriodInterval the endpoint is expected to be operational
... payloadType SΣ1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... text SΣ1..1stringPlain text representation of the concept
Fixed Value: n/a
... payloadMimeType Σ0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required)
... address SΣ1..1urlThe technical base address for connecting to this endpoint
... header S0..*stringUsage depends on the channel type

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.