Argonaut Provider Directory Implementation Guide Version 1.0.0

This page is part of the Argonaut Provider Directory Guide (v1.0.0: Release) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

SD.1 StructureDefinition-argo-endpoint

Scope and Usage

This profile sets minimum expectations for the Endpoint resource to record, search and fetch an Endpoint associated with a Provider or Organization. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the Endpoint resource when using this profile. The requirements for the Argonaut Provider Directory data model were drawn from IHE Healthcare Provider Directory and the ONC Provider Directory Workshop.

Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These 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 name
  3. A managing organization
  4. The channel type to send notifications on (connectionType)
  5. The address

Profile specific implementation guidance:

  • None
Examples

SD.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-endpoint

This profile builds on Endpoint.

This profile was published on Wed Nov 09 00:00:00 AEDT 2016 as a draft by Argonaut Project.

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

Summary of the Mandatory Requirements

  1. One status code in Endpoint.status which has a required binding to:
  2. One name in Endpoint.name
  3. One reference to a managing organization in Endpoint.managingOrganization
  4. One channel type code in Endpoint.connectionType which has an required binding to:
  5. One address in Endpoint.address
  6. One payload type code in Endpoint.payloadType which has an extensible binding to:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*Argonaut Provider Directory Endpoint
... status S1..1codeBinding: EndpointStatus (required)
... connectionType S1..1CodingBinding: Endpoint Connection Type (required)
... name S1..1string
... managingOrganization S1..1Reference(http://fhir.org/guides/argonaut-pd/StructureDefinition-argo-organization)
... payloadType S1..*CodeableConceptBinding: Endpoint Payload Type (extensible)
... address S1..1uri

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint I0..*Argonaut Provider Directory Endpoint
... 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: Common Languages (extensible)
... text I0..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: Endpoint Connection Type (required)
... name SΣ1..1stringA name that this endpoint can be identified by
... managingOrganization SΣ1..1Reference(http://fhir.org/guides/argonaut-pd/StructureDefinition-argo-organization)Organization that manages this endpoint (may 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..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type (extensible)
... 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 SΣ1..1uriThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

Summary of the Mandatory Requirements

  1. One status code in Endpoint.status which has a required binding to:
  2. One name in Endpoint.name
  3. One reference to a managing organization in Endpoint.managingOrganization
  4. One channel type code in Endpoint.connectionType which has an required binding to:
  5. One address in Endpoint.address
  6. One payload type code in Endpoint.payloadType which has an extensible binding to:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*Argonaut Provider Directory Endpoint
... status S1..1codeBinding: EndpointStatus (required)
... connectionType S1..1CodingBinding: Endpoint Connection Type (required)
... name S1..1string
... managingOrganization S1..1Reference(http://fhir.org/guides/argonaut-pd/StructureDefinition-argo-organization)
... payloadType S1..*CodeableConceptBinding: Endpoint Payload Type (extensible)
... address S1..1uri

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint I0..*Argonaut Provider Directory Endpoint
... 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: Common Languages (extensible)
... text I0..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: Endpoint Connection Type (required)
... name SΣ1..1stringA name that this endpoint can be identified by
... managingOrganization SΣ1..1Reference(http://fhir.org/guides/argonaut-pd/StructureDefinition-argo-organization)Organization that manages this endpoint (may 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..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type (extensible)
... 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 SΣ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

 

SD.1.2 - Quick Start

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

GET [base]/Endpoint?identifier=[system]|[code]

Example: GET [base]/Endpoint?identifier=http://hospital.smarthealthit.org/Endpoints|103270514

Support: Mandatory to search by identifier.

Implementation Notes: Search based on Endpoint identifier (how to search by token).

GET [base]/Endpoint?organization=[id]

Example: GET [base]/Endpoint?organization=2354

Support: Mandatory to support search by organization.

Implementation Notes: Search based on organization (how to search by reference).

GET [base]/Endpoint?name=[string]

Example: GET [base]/Endpoint?name=good health hospital

Support: Mandatory to support search by Endpoint name.

Implementation Notes: Search based on name (how to search by string).