Validated Healthcare Directory IG STU1 Draft for Comment

This page is part of the Validated Healthcare Directory FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.2.0. . For a full list of available versions, see the Directory of published versions

1.0 - StructureDefinition: vhdir-endpoint - Content

This profile sets minimum expectations for searching for and fetching information associated with an electronic endpoint. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the endpoint resource when using this profile.

Background & Scope

An endpoint describes the technical details of a location that can be connected to for the delivery/retrieval of information.

This profile constrains endpoint.managingOrganization and endpoint.period (both are now required), as well as endpoint.contact (only one contact point for an endpoint is permitted).

Examples:

The following are example uses for the vhdir-endpoint profile:

  • TBD

Mandatory Data Elements

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each endpoint must have:

  1. A status in endpoint.status
  2. A connectionType in endpoint.connectionType
  3. An organization responsible for managing the endpoint in endpoint.managingOrganization
  4. A period for which the endpoint is available in endpoint.period
  5. At least one indication of the type of content the endpoint supports in endpoint.payloadType
  6. One technical address for connecting to the endpoint in endpoint.address
  7. For each use case defined for the endpoint, one indication of the type of services provided in endpoint.useCase.type

Profile specific implementation guidance:

  • TBD

Extensions:

  1. Restriction (0..*) - indicates restrictions on the use/release of information associated with the endpoint
  2. UseCase (0..*) - an enumeration of the specific use cases (service descriptions) supported by the endpoint, consisting of:
    1. Type (1.1) - the types of services supported by the endpoint
    2. Standard (0..1) - URI of a published standard (e.g. an HL7 implementation guide)
  3. Rank (0..1) - an indication of the preferred order for connecting to an endpoint when multiple endpoints capable of transferring the same content are listed
  4. DigitalCertificate (0..*) - a digital certificate associated with the endpoint

Terminology

TBD

1.2 - Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/ig/vhdir/StructureDefinition/vhdir-endpoint

Defines the basic constraints and extensions on the Endpoint resource for use in a Validated Healthcare Directory

This profile builds on Endpoint.

This profile was published on Wed Oct 04 00:34:40 AEDT 2017 as a draft by null.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Complete Summary of the Mandatory Requirements

  1. A status in endpoint.status
  2. A connectionType in endpoint.connectionType
  3. An organization responsible for managing the endpoint in endpoint.managingOrganization
  4. A period for which the endpoint is available in endpoint.period
  5. At least one indication of the type of content the endpoint supports in endpoint.payloadType
  6. One technical address for connecting to the endpoint in endpoint.address
  7. For each use case defined for the endpoint, one indication of the type of services provided in endpoint.useCase.type
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
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... endpoint-useCase 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-useCase
... endpoint-rank 0..1positiveIntExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-rank
... digitalCertificate 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifies this endpoint across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... identifier-status 0..1codeExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status"
..... valueCode 0..1codeStatus
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required)
... connectionType Σ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (extensible)
... name Σ0..1stringA name that this endpoint can be identified by
... managingOrganization Σ1..1Reference(Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..1ContactPointContact details for source (e.g. troubleshooting)
.... id 0..1stringxml:id (or equivalent in JSON)
.... contactPoint-availableTime 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionDays of week
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"daysOfWeek"
...... valueCode 0..1codeDays of week
..... extension 0..1ExtensionAll day
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"allDay"
...... valueBoolean 0..1booleanAll day
..... extension 0..1ExtensionAvailable start time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableStartTime"
...... valueTime 0..1timeAvailable start time
..... extension 0..1ExtensionAvailable end time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableEndTime"
...... valueTime 0..1timeAvailable end time
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime"
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary"
..... value[x] 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Via intermediary
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... period Σ1..1PeriodInterval the endpoint is expected to be operational
... payloadType Σ1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type (example)
... payloadMimeType Σ0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: IETF BCP-13 (required)
... address Σ1..1uriThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

Complete Summary of the Mandatory Requirements

  1. A status in endpoint.status
  2. A connectionType in endpoint.connectionType
  3. An organization responsible for managing the endpoint in endpoint.managingOrganization
  4. A period for which the endpoint is available in endpoint.period
  5. At least one indication of the type of content the endpoint supports in endpoint.payloadType
  6. One technical address for connecting to the endpoint in endpoint.address
  7. For each use case defined for the endpoint, one indication of the type of services provided in endpoint.useCase.type

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
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... endpoint-useCase 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-useCase
... endpoint-rank 0..1positiveIntExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-rank
... digitalCertificate 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifies this endpoint across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... identifier-status 0..1codeExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status"
..... valueCode 0..1codeStatus
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required)
... connectionType Σ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (extensible)
... name Σ0..1stringA name that this endpoint can be identified by
... managingOrganization Σ1..1Reference(Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..1ContactPointContact details for source (e.g. troubleshooting)
.... id 0..1stringxml:id (or equivalent in JSON)
.... contactPoint-availableTime 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionDays of week
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"daysOfWeek"
...... valueCode 0..1codeDays of week
..... extension 0..1ExtensionAll day
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"allDay"
...... valueBoolean 0..1booleanAll day
..... extension 0..1ExtensionAvailable start time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableStartTime"
...... valueTime 0..1timeAvailable start time
..... extension 0..1ExtensionAvailable end time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableEndTime"
...... valueTime 0..1timeAvailable end time
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime"
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary"
..... value[x] 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Via intermediary
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... period Σ1..1PeriodInterval the endpoint is expected to be operational
... payloadType Σ1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type (example)
... payloadMimeType Σ0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: IETF BCP-13 (required)
... address Σ1..1uriThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

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

 

1.3 - Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.

TBD