HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.0.0 - STU 2

This page is part of the electronic Case Reporting (eCR) (v2.0.0: STU 2 on FHIR R4) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: US Public Health Endpoint

Defining URL:http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-endpoint
Version:2.0.0
Name:USPublicHealthEndpoint
Title:US Public Health Endpoint
Status:Draft as of 9/1/19
Definition:

This is the Endpoint Resource profile for the IG used to specify receivers addresses

Publisher:HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-endpoint

Formal Views of Profile Content

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

This structure is derived from Endpoint

Summary

Mandatory: 3 elements
Must-Support: 3 elements

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointUS Public Health Endpoint
... 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..*EndpointUS Public Health Endpoint
... id Σ0..1stringLogical 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointUS Public Health Endpoint
... status ?!Σ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType Σ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
... address Σ1..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format

This structure is derived from Endpoint

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Differential View

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointUS Public Health Endpoint
... 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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointUS Public Health Endpoint
... id Σ0..1stringLogical 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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Endpoint.languagepreferredCommonLanguages
Max Binding: AllLanguages
Endpoint.statusrequiredEndpointStatus
Endpoint.connectionTypeextensibleEndpointConnectionType
Endpoint.payloadTypeexampleEndpointPayloadType
Endpoint.payloadMimeTyperequiredMime Types

Constraints

IdGradePathDetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEndpointIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorEndpoint.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEndpoint.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEndpoint.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEndpoint.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorEndpoint.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.connectionTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.managingOrganizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.payloadTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.payloadMimeTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorEndpoint.headerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())