This page is part of the US Public Health Profiles Library (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-endpoint | Version: 1.0.0-ballot | |||
Draft as of 2019-09-01 | Computable Name: USPublicHealthEndpoint |
This is the Endpoint Resource profile for the IG used to specify receivers addresses
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Endpoint
This structure is derived from Endpoint
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Endpoint | US Public Health Endpoint | |
![]() ![]() ![]() | S | 1..1 | code | active | suspended | error | off | entered-in-error | test |
![]() ![]() ![]() | S | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection |
![]() ![]() ![]() | S | 1..1 | url | The technical base address for connecting to this endpoint |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Endpoint | US Public Health Endpoint | |||||
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
![]() ![]() ![]() | ?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. | ||||
![]() ![]() ![]() | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) | ||||
![]() ![]() ![]() | Σ | 0..1 | string | A name that this endpoint can be identified by | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
![]() ![]() ![]() | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
![]() ![]() ![]() | Σ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
![]() ![]() ![]() | Σ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) | ||||
![]() ![]() ![]() | Σ | 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. | ||||
![]() ![]() ![]() | SΣ | 1..1 | url | The technical base address for connecting to this endpoint | ||||
![]() ![]() ![]() | 0..* | string | Usage depends on the channel type | |||||
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Endpoint | US Public Health Endpoint | |
![]() ![]() ![]() | ?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. |
![]() ![]() ![]() | Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) |
![]() ![]() ![]() | Σ | 1..1 | url | The technical base address for connecting to this endpoint |
![]() |
This structure is derived from Endpoint
Differential View
This structure is derived from Endpoint
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Endpoint | US Public Health Endpoint | |
![]() ![]() ![]() | S | 1..1 | code | active | suspended | error | off | entered-in-error | test |
![]() ![]() ![]() | S | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection |
![]() ![]() ![]() | S | 1..1 | url | The technical base address for connecting to this endpoint |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Endpoint | US Public Health Endpoint | |||||
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
![]() ![]() ![]() | ?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. | ||||
![]() ![]() ![]() | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) | ||||
![]() ![]() ![]() | Σ | 0..1 | string | A name that this endpoint can be identified by | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
![]() ![]() ![]() | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
![]() ![]() ![]() | Σ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
![]() ![]() ![]() | Σ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) | ||||
![]() ![]() ![]() | Σ | 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. | ||||
![]() ![]() ![]() | SΣ | 1..1 | url | The technical base address for connecting to this endpoint | ||||
![]() ![]() ![]() | 0..* | string | Usage depends on the channel type | |||||
![]() |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Endpoint.language | preferred | CommonLanguages Max Binding: AllLanguages |
Endpoint.status | required | EndpointStatus |
Endpoint.connectionType | extensible | EndpointConnectionType |
Endpoint.payloadType | example | EndpointPayloadType |
Endpoint.payloadMimeType | required | Mime Types |
Id | Grade | Path | 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 | Endpoint.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Endpoint.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Endpoint.modifierExtension | 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() | |
ele-1 | error | Endpoint.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.connectionType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.payloadType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.payloadMimeType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Endpoint.header | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |