Making EHR Data More available for Research and Public Health (MedMorph)
0.2.0 - STU 1 draft
Making EHR Data More available for Research and Public Health (MedMorph)
0.2.0 - STU 1 draft
This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) (v0.2.0: STU 1 Draft) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-endpoint |
| Version: | 0.2.0 |
| Name: | USPublicHealthEndpoint |
| Title: | USPH 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 International - Public Health Work Group |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-endpoint
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 |
|---|---|---|---|---|
  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 | |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | USPH Endpoint | |
| status | ?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. |
| connectionType | Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) |
| address | Σ | 1..1 | url | The technical base address for connecting to this endpoint |
| Documentation for this format | ||||
This structure is derived from Endpoint
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 | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | USPH Endpoint | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | ||||
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 | Path | Details | Requirements |
| dom-2 | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Endpoint | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Endpoint.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Endpoint.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Endpoint.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Endpoint.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Endpoint.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.connectionType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.payloadType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.payloadMimeType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Endpoint.header | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Public Health Work Group. Package hl7.fhir.us.medmorph#0.2.0 based on FHIR 4.0.1. Generated 2021-12-08
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change