​

SD.4 StructureDefinition-dpc-profile-endpoint

The profile defines the required format for Endpoint resources associated to a given Organization. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

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. an id
  2. a status
  3. a connection type
  4. a name
  5. a managing organization
  6. an address

SD.4.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-endpoint

Published on Wed Apr 21 11:33:40 EDT 2021 as a draft by The DPC Team.

This profile builds on Endpoint

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... name 1..1stringA name that this endpoint can be identified by
... managingOrganization 1..1Reference(DPC Organization)Organization that manages this endpoint (may not be the organization that exposes the endpoint)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint I0..*EndpointThe 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: Common Languages (extensible)
Max Binding: All Languages
... 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 ?!Σ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 Σ1..1stringA name that this endpoint can be identified by
... managingOrganization Σ1..1Reference(DPC 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 Σ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: mimetypes (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), Schema: XML Schematron