DaVinci PDEX Plan Net
1.2.0 - STU 2 (ci-build) United States of America flag

DaVinci PDEX Plan Net, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 1.2.0 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

Resource Profile: Plan-Net Endpoint

Official URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint Version: 1.2.0
Standards status: Trial-use 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.

Implementation Guidance

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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Additional Bindings Purpose
Minimum Endpoint Connection Types VS Min Binding
http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointPayloadTypeVS
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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
... connectionType SΣ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types VS (extensible)
Additional BindingsPurpose
Minimum Endpoint Connection Types VS Min Binding
... 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ΣC 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.

... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Additional Bindings Purpose
Minimum Endpoint Connection Types VS Min Binding
http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.contact.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Endpoint.contact.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... 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
... 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)
Additional BindingsPurpose
Minimum Endpoint Connection Types VS Min Binding
... 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
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Endpoint.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Additional Bindings Purpose
Minimum Endpoint Connection Types VS Min Binding
http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.contact.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Endpoint.contact.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

This structure is derived from Endpoint

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 11 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Additional Bindings Purpose
Minimum Endpoint Connection Types VS Min Binding
http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointPayloadTypeVS
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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
... connectionType SΣ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types VS (extensible)
Additional BindingsPurpose
Minimum Endpoint Connection Types VS Min Binding
... 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ΣC 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.

... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Additional Bindings Purpose
Minimum Endpoint Connection Types VS Min Binding
http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.contact.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Endpoint.contact.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... 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
... 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)
Additional BindingsPurpose
Minimum Endpoint Connection Types VS Min Binding
... 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
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Endpoint.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Additional Bindings Purpose
Minimum Endpoint Connection Types VS Min Binding
http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.contact.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Endpoint.contact.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

This structure is derived from Endpoint

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 11 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron