Da Vinci PDex Plan Net
2.0.0-ballot - STU2 United States of America flag

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

Resource Profile: Plan-Net Endpoint

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

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

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... extension: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

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.

Constraints

Id Grade Path(s) Description Expression

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension: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)
Additional BindingsPurpose
Minimum Endpoint Connection Types VS Min Binding
... 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)

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
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension: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

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.

Constraints

Id Grade Path(s) Description Expression

Summary

Must-Support: 11 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... extension: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

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.

Constraints

Id Grade Path(s) Description Expression

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension: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)
Additional BindingsPurpose
Minimum Endpoint Connection Types VS Min Binding
... 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)

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension: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

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.

Constraints

Id Grade Path(s) Description Expression

Summary

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