Making Electronic Data More available for Research and Public Health (MedMorph)
1.0.0 - STU 1

Making Electronic Data More available for Research and Public Health (MedMorph), published by HL7 International - Public Health Work 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-medmorph/ and changes regularly. See the Directory of published versions

## Resource Profile: USPublicHealthEndpoint

Official URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-endpoint | Version: 1.0.0
Draft as of 2019-09-01 | Computable Name: USPublicHealthEndpoint

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

Usage:

- Refer to this Resource Profile: US Public Health Receiver Endpoint and US Public Health Trust Service Endpoint
- Examples for this Resource Profile: HealthCareSenderAndReceiver and PHAReceiver

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Endpoint

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Endpoint |  | 0..* | Endpoint | USPH Endpoint
status | S | 1..1 | code | active | suspended | error | off | entered-in-error | test
connectionType | S | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection
address | S | 1..1 | url | The technical base address for connecting to this endpoint
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Endpoint |  | 0..* | Endpoint | USPH Endpoint
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
connectionType | S Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible)
payloadType | Σ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example)
address | S Σ | 1..1 | url | The technical base address for connecting to this endpoint
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Endpoint.status | required | EndpointStatus
Endpoint.connectionType | extensible | EndpointConnectionType
Endpoint.payloadType | example | EndpointPayloadType

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Endpoint | If 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-4 | error | Endpoint | If 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-5 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Endpoint | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Endpoint |  | 0..* | Endpoint | USPH 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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 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): The status of the endpoint.
connectionType | S Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible)
name | Σ | 0..1 | string | A name that this endpoint can be identified by
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that manages this endpoint (might 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 | Σ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example)
payloadMimeType | Σ | 0..* | code | Mimetype 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..1 | url | The technical base address for connecting to this endpoint
header |  | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Endpoint.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Endpoint.status | required | EndpointStatus
Endpoint.connectionType | extensible | EndpointConnectionType
Endpoint.payloadType | example | EndpointPayloadType
Endpoint.payloadMimeType | required | Mime Types (a valid code from `urn:ietf:bcp:13`)

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from Endpoint

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Differential View

This structure is derived from Endpoint

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Endpoint |  | 0..* | Endpoint | USPH Endpoint
status | S | 1..1 | code | active | suspended | error | off | entered-in-error | test
connectionType | S | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection
address | S | 1..1 | url | The technical base address for connecting to this endpoint
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Endpoint |  | 0..* | Endpoint | USPH Endpoint
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
connectionType | S Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible)
payloadType | Σ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example)
address | S Σ | 1..1 | url | The technical base address for connecting to this endpoint
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Endpoint.status | required | EndpointStatus
Endpoint.connectionType | extensible | EndpointConnectionType
Endpoint.payloadType | example | EndpointPayloadType

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Endpoint | If 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-4 | error | Endpoint | If 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-5 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Endpoint | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Endpoint |  | 0..* | Endpoint | USPH 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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 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): The status of the endpoint.
connectionType | S Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible)
name | Σ | 0..1 | string | A name that this endpoint can be identified by
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that manages this endpoint (might 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 | Σ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example)
payloadMimeType | Σ | 0..* | code | Mimetype 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..1 | url | The technical base address for connecting to this endpoint
header |  | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Endpoint.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Endpoint.status | required | EndpointStatus
Endpoint.connectionType | extensible | EndpointConnectionType
Endpoint.payloadType | example | EndpointPayloadType
Endpoint.payloadMimeType | required | Mime Types (a valid code from `urn:ietf:bcp:13`)

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from Endpoint

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Other representations of profile: CSV, Excel, Schematron