US Public Health Profiles Library
1.0.0 - STU1 United States of America flag

US Public Health Profiles Library, published by HL7 Public Health Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-us-ph-common-library-ig/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health Endpoint

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-endpoint Version: 1.0.0
Active as of 2023-10-04 Computable Name: USPublicHealthEndpoint

This Endpoint profile indicates where the report is to be sent.

Usage:

Formal Views of Profile Content

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

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... status S1..1codeactive | suspended | error | off | entered-in-error | test
... connectionType S1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
... address S1..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.

... payloadType Σ1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... address SΣ1..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Endpoint.statusrequiredEndpointStatus
Endpoint.connectionTypeextensibleEndpointConnectionType
Endpoint.payloadTypeexampleEndpointPayloadType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*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
... 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): The status of the endpoint.

... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
... 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 Σ1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... 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): The mime type of an attachment. Any valid mime type is allowed.


... address SΣ1..1urlThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Endpoint.statusrequiredEndpointStatus
Endpoint.connectionTypeextensibleEndpointConnectionType
Endpoint.payloadTypeexampleEndpointPayloadType
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)

This structure is derived from Endpoint

Summary

Must-Support: 3 elements

Differential View

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... status S1..1codeactive | suspended | error | off | entered-in-error | test
... connectionType S1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
... address S1..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.

... payloadType Σ1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... address SΣ1..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Endpoint.statusrequiredEndpointStatus
Endpoint.connectionTypeextensibleEndpointConnectionType
Endpoint.payloadTypeexampleEndpointPayloadType

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*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
... 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): The status of the endpoint.

... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
... 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 Σ1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... 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): The mime type of an attachment. Any valid mime type is allowed.


... address SΣ1..1urlThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Endpoint.statusrequiredEndpointStatus
Endpoint.connectionTypeextensibleEndpointConnectionType
Endpoint.payloadTypeexampleEndpointPayloadType
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)

This structure is derived from Endpoint

Summary

Must-Support: 3 elements

 

Other representations of profile: CSV, Excel, Schematron