Provider Directory

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:

A status
A name
A managing organization
The channel type to send notifications on (connectionType)
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

One status code in Endpoint.status which has a required binding to:
- EndpointStatus value set
One name in Endpoint.name
One reference to a managing organization in Endpoint.managingOrganization
One channel type code in Endpoint.connectionType which has an required binding to:
- SubscriptionChannelType value set
One address in Endpoint.address
One payload type code in Endpoint.payloadType which has an extensible binding to:
- Endpoint Payload Type value set.

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*		Argonaut Provider Directory Endpoint
status	S	1..1	code	Binding: EndpointStatus (required)
connectionType	S	1..1	Coding	Binding: Endpoint Connection Type (required)
name	S	1..1	string
managingOrganization	S	1..1	Reference(http://fhir.org/guides/argonaut-pd/StructureDefinition-argo-organization)
payloadType	S	1..*	CodeableConcept	Binding: Endpoint Payload Type (extensible)
address	S	1..1	uri
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Endpoint	I	0..*		Argonaut Provider Directory Endpoint
id	Î£	0..1	id	Logical id of this artifact
meta	Î£	0..1	Meta	Metadata about the resource
implicitRules	?!Î£	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible)
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Î£	0..*	Identifier	Identifies this endpoint across multiple systems
status	?!SÎ£	1..1	code	active \| suspended \| error \| off \| entered-in-error \| test Binding: EndpointStatus (required)
connectionType	SÎ£	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Type (required)
name	SÎ£	1..1	string	A name that this endpoint can be identified by
managingOrganization	SÎ£	1..1	Reference(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..*	ContactPoint	Contact details for source (e.g. troubleshooting)
period	Î£	0..1	Period	Interval the endpoint is expected to be operational
payloadType	SÎ£	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type (extensible)
payloadMimeType	Î£	0..*	code	Mimetype 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..1	uri	The technical base address for connecting to this endpoint
header		0..*	string	Usage depends on the channel type
Documentation for this format

Summary of the Mandatory Requirements

One status code in Endpoint.status which has a required binding to:
- EndpointStatus value set
One name in Endpoint.name
One reference to a managing organization in Endpoint.managingOrganization
One channel type code in Endpoint.connectionType which has an required binding to:
- SubscriptionChannelType value set
One address in Endpoint.address
One payload type code in Endpoint.payloadType which has an extensible binding to:
- Endpoint Payload Type value set.

Differential View

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*		Argonaut Provider Directory Endpoint
status	S	1..1	code	Binding: EndpointStatus (required)
connectionType	S	1..1	Coding	Binding: Endpoint Connection Type (required)
name	S	1..1	string
managingOrganization	S	1..1	Reference(http://fhir.org/guides/argonaut-pd/StructureDefinition-argo-organization)
payloadType	S	1..*	CodeableConcept	Binding: Endpoint Payload Type (extensible)
address	S	1..1	uri
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Endpoint	I	0..*		Argonaut Provider Directory Endpoint
id	Î£	0..1	id	Logical id of this artifact
meta	Î£	0..1	Meta	Metadata about the resource
implicitRules	?!Î£	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible)
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Î£	0..*	Identifier	Identifies this endpoint across multiple systems
status	?!SÎ£	1..1	code	active \| suspended \| error \| off \| entered-in-error \| test Binding: EndpointStatus (required)
connectionType	SÎ£	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Type (required)
name	SÎ£	1..1	string	A name that this endpoint can be identified by
managingOrganization	SÎ£	1..1	Reference(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..*	ContactPoint	Contact details for source (e.g. troubleshooting)
period	Î£	0..1	Period	Interval the endpoint is expected to be operational
payloadType	SÎ£	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type (extensible)
payloadMimeType	Î£	0..*	code	Mimetype 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..1	uri	The technical base address for connecting to this endpoint
header		0..*	string	Usage depends on the channel type
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).