US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-endpoint | Version: 2.0.0 | |||
| Standards status: Trial-use Active as of 2025-10-23 | Maturity Level: 3 | Computable Name: USPublicHealthEndpoint | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.24 | ||||
This Endpoint profile indicates where the report is to be sent.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Endpoint |
0..* | Endpoint(4.0.1) | US Public Health Endpoint | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Type | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | example | Endpoint Payload Type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Endpoint.implicitRules, Endpoint.modifierExtension, Endpoint.status, Endpoint.connectionType, Endpoint.payloadType, Endpoint.address | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Endpoint.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Endpoint |
0..* | Endpoint(4.0.1) | US Public Health 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 Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint |
0..* | Endpoint(4.0.1) | US Public Health 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Type | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | example | Endpoint Payload Type | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Endpoint.meta, Endpoint.implicitRules, Endpoint.language, Endpoint.text, Endpoint.extension, Endpoint.modifierExtension, Endpoint.identifier, Endpoint.status, Endpoint.connectionType, Endpoint.name, Endpoint.managingOrganization, Endpoint.contact, Endpoint.period, Endpoint.payloadType, Endpoint.payloadMimeType, Endpoint.address, Endpoint.header | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Endpoint.extension, Endpoint.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Endpoint |
0..* | Endpoint(4.0.1) | US Public Health Endpoint | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Type | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | example | Endpoint Payload Type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Endpoint.implicitRules, Endpoint.modifierExtension, Endpoint.status, Endpoint.connectionType, Endpoint.payloadType, Endpoint.address | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Endpoint.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Endpoint |
0..* | Endpoint(4.0.1) | US Public Health 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 | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint |
0..* | Endpoint(4.0.1) | US Public Health 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Type | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | example | Endpoint Payload Type | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Endpoint.meta, Endpoint.implicitRules, Endpoint.language, Endpoint.text, Endpoint.extension, Endpoint.modifierExtension, Endpoint.identifier, Endpoint.status, Endpoint.connectionType, Endpoint.name, Endpoint.managingOrganization, Endpoint.contact, Endpoint.period, Endpoint.payloadType, Endpoint.payloadMimeType, Endpoint.address, Endpoint.header | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Endpoint.extension, Endpoint.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 International / Public Health.
Package hl7.fhir.us.ph-library#2.0.0 based on FHIR 4.0.1.
Generated 2025-10-23
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
