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
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Endpoint
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
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 | The technical details of an endpoint that can be used for electronic services | |
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 |
Path | Conformance | ValueSet |
Endpoint.status | required | EndpointStatus |
Endpoint.connectionType | extensible | EndpointConnectionType |
Endpoint.payloadType | example | EndpointPayloadType |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
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 | |||||
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 |
Path | Conformance | ValueSet | ||||
Endpoint.language | preferred | CommonLanguages
| ||||
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 ) |
This structure is derived from Endpoint
Differential View
This structure is derived from Endpoint
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
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 | The technical details of an endpoint that can be used for electronic services | |
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 |
Path | Conformance | ValueSet |
Endpoint.status | required | EndpointStatus |
Endpoint.connectionType | extensible | EndpointConnectionType |
Endpoint.payloadType | example | EndpointPayloadType |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
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 | |||||
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 |
Path | Conformance | ValueSet | ||||
Endpoint.language | preferred | CommonLanguages
| ||||
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 ) |
This structure is derived from Endpoint
Other representations of profile: CSV, Excel, Schematron