DaVinci PDEX Plan Net
1.1.0 - STU 1.1
US
DaVinci PDEX Plan Net
1.1.0 - STU 1.1
US
This page is part of the DaVinci PDEX Plan Net (v1.1.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint | Version: 1.1.0 | |||
| Active as of 2022-04-04 | Computable Name: PlannetEndpoint | |||
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.
| ConnectionType 1..1 (value) | PayloadType 1..1 (value) | PayloadMimeType 0..* (description) |
|---|---|---|
| hl7-fhir-rest | NA | Ignored |
| hl7-fhir-msg | NA | Ignored |
| hl7-fhir-opn | NA | Ignored |
| direct-project | NA | Relevant MIME Types |
| rest-non-fhir | NA | Relevant MIME Types |
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 |
|---|---|---|---|---|
  Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
  meta | ||||
  lastUpdated | 1..1 | instant | When the resource version last changed | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 endpoint-usecase | S | 0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase |
| status | S | 1..1 | code | active | suspended | error | off | entered-in-error | test Fixed Value: active |
| connectionType | S | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types VS (extensible) |
| name | S | 0..1 | string | A name that this endpoint can be identified by |
 managingOrganization | S | 0..1 | Reference(Plan-Net Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| contact | S | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) |
| system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
| value | S | 0..1 | string | The actual contact point details |
| payloadType | S | 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) |
| payloadMimeType | S | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) |
| 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 | |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed |
| source | Σ | 0..1 | uri | Identifies where the resource comes from |
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| 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 | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| endpoint-usecase | S | 0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase |
 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. Fixed Value: active |
| connectionType | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types VS (extensible) Min Binding: Minimum Endpoint Connection Types VS |
| name | SΣ | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | SΣ | 0..1 | Reference(Plan-Net Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| contact | S | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
| period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational |
| payloadType | SΣ | 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) |
| payloadMimeType | SΣ | 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 | The technical details of an endpoint that can be used for electronic services | |
| endpoint-usecase | 0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase | |
| status | ?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active |
| connectionType | Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types VS (extensible) Min Binding: Minimum Endpoint Connection Types VS |
| name | Σ | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | Σ | 0..1 | Reference(Plan-Net 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) | |
| system | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | Σ | 0..1 | string | The actual contact point details |
| payloadType | Σ | 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) |
| 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 | Σ | 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 | The technical details of an endpoint that can be used for electronic services | |
| meta | ||||
| lastUpdated | 1..1 | instant | When the resource version last changed | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| endpoint-usecase | S | 0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase |
| status | S | 1..1 | code | active | suspended | error | off | entered-in-error | test Fixed Value: active |
| connectionType | S | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types VS (extensible) |
| name | S | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | S | 0..1 | Reference(Plan-Net Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| contact | S | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) |
| system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
| value | S | 0..1 | string | The actual contact point details |
| payloadType | S | 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) |
| payloadMimeType | S | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) |
| 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 | The technical details of an endpoint that can be used for electronic services | |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed |
| source | Σ | 0..1 | uri | Identifies where the resource comes from |
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| 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 | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| endpoint-usecase | S | 0..* | (Complex) | Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase |
| 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. Fixed Value: active |
| connectionType | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types VS (extensible) Min Binding: Minimum Endpoint Connection Types VS |
| name | SΣ | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | SΣ | 0..1 | Reference(Plan-Net Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| contact | S | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
| period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational |
| payloadType | SΣ | 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) |
| payloadMimeType | SΣ | 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 / Code |
| Endpoint.meta.security | extensible | All Security Labels |
| Endpoint.meta.tag | example | CommonTags |
| Endpoint.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Endpoint.status | required | Fixed Value: active |
| Endpoint.connectionType | extensible | EndpointConnectionTypeVS Min Binding: Minimum Endpoint Connection Types VS |
| Endpoint.contact.system | required | ContactPointSystem |
| Endpoint.contact.use | required | ContactPointUse |
| Endpoint.payloadType | extensible | EndpointPayloadTypeVS |
| Endpoint.payloadMimeType | required | Mime Types |
IG © 2022+ HL7 Financial Management Working Group. Package hl7.fhir.us.davinci-pdex-plan-net#1.1.0 based on FHIR 4.0.1. Generated 2022-04-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change