Da Vinci PDex Plan Net, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pdex-plan-net/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint | Version: 2.0.0-ballot | ||||
| Standards status: Trial-use | Computable Name: PlannetEndpoint | ||||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.28.42.10 | |||||
The technical details of an endpoint that can be used for electronic services, such as a portal or FHIR REST services, messaging or operations, or DIRECT messaging.
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: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active (no extensions allowed) | |||||
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types VS (extensible)
| |||||
![]() ![]() |
0..1 | string | A name that this endpoint can be identified by | |||||
![]() ![]() |
0..1 | Reference(Plan-Net Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |||||
![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
0..1 | string | The actual contact point details | |||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Types VS (extensible) | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
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 Types VS | 📦2.0.0-ballot | This IG |
| Endpoint.contact.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Types VS | 📦2.0.0-ballot | This IG |
| Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase | |||||
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Fixed Value: active (no extensions allowed) | |||||
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types VS (extensible)
| |||||
![]() ![]() |
0..1 | string | A name that this endpoint can be identified by | |||||
![]() ![]() |
0..1 | Reference(Plan-Net 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 | code | phone | fax | email | pager | url | sms | other | |||||
![]() ![]() ![]() |
0..1 | string | The actual contact point details | |||||
![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Types VS (extensible) | |||||
![]() ![]() |
0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) | |||||
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types VS | 📦2.0.0-ballot | This IG |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Types VS | 📦2.0.0-ballot | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() |
0..1 | id | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems | |||||
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active (no extensions allowed) | |||||
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types VS (extensible)
| |||||
![]() ![]() |
0..1 | string | A name that this endpoint can be identified by | |||||
![]() ![]() |
0..1 | Reference(Plan-Net 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 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
0..1 | string | The actual contact point details | |||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when the contact point was/is in use | |||||
![]() ![]() |
0..1 | Period | Interval the endpoint is expected to be operational | |||||
![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Types VS (extensible) | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |||||
![]() ![]() |
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 Types VS | 📦2.0.0-ballot | This IG |
| Endpoint.contact.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Types VS | 📦2.0.0-ballot | This IG |
| Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Endpoint
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active (no extensions allowed) | |||||
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types VS (extensible)
| |||||
![]() ![]() |
0..1 | string | A name that this endpoint can be identified by | |||||
![]() ![]() |
0..1 | Reference(Plan-Net Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |||||
![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
0..1 | string | The actual contact point details | |||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Types VS (extensible) | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
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 Types VS | 📦2.0.0-ballot | This IG |
| Endpoint.contact.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Types VS | 📦2.0.0-ballot | This IG |
| Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase | |||||
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Fixed Value: active (no extensions allowed) | |||||
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types VS (extensible)
| |||||
![]() ![]() |
0..1 | string | A name that this endpoint can be identified by | |||||
![]() ![]() |
0..1 | Reference(Plan-Net 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 | code | phone | fax | email | pager | url | sms | other | |||||
![]() ![]() ![]() |
0..1 | string | The actual contact point details | |||||
![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Types VS (extensible) | |||||
![]() ![]() |
0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) | |||||
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.connectionType | Base | extensible | Endpoint Connection Types VS | 📦2.0.0-ballot | This IG |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Types VS | 📦2.0.0-ballot | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() |
0..1 | id | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems | |||||
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active (no extensions allowed) | |||||
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types VS (extensible)
| |||||
![]() ![]() |
0..1 | string | A name that this endpoint can be identified by | |||||
![]() ![]() |
0..1 | Reference(Plan-Net 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 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
0..1 | string | The actual contact point details | |||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when the contact point was/is in use | |||||
![]() ![]() |
0..1 | Period | Interval the endpoint is expected to be operational | |||||
![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Types VS (extensible) | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |||||
![]() ![]() |
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 Types VS | 📦2.0.0-ballot | This IG |
| Endpoint.contact.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Endpoint.contact.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Types VS | 📦2.0.0-ballot | This IG |
| Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Endpoint
Other representations of profile: CSV, Excel, Schematron