DaVinci PDEX Plan Net
1.0.0 - STU1

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

Defining URL:http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint
Version:1.0.0
Name:PlannetEndpoint
Title:Plan-Net Endpoint
Status:Active as of 2020-12-20T02:56:54+00:00
Definition:

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.

Publisher:HL7 Financial Management Working Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint

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

Formal Views of Profile Content

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

This structure is derived from Endpoint

Summary

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

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase S0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase
... connectionType S1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types (extensible)
... name S0..1stringA name that this endpoint can be identified by
... managingOrganization S0..1Reference(Plan-Net Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact S0..*ContactPointContact details for source (e.g. troubleshooting)
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value S0..1stringThe actual contact point details
... payloadType S1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Types (extensible)
... payloadMimeType S0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
... address S1..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase S0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifies this endpoint across multiple systems
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types (extensible)
Min Binding: Minimum Endpoint Connection Types
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ0..1Reference(Plan-Net Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact S0..*ContactPointContact details for source (e.g. troubleshooting)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... period Σ0..1PeriodInterval the endpoint is expected to be operational
... payloadType SΣ1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Types (extensible)
... payloadMimeType SΣ0..*codeMimetype 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..1urlThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe 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..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType Σ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types (extensible)
Min Binding: Minimum Endpoint Connection Types
... managingOrganization Σ0..1Reference(Plan-Net Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..*ContactPointContact details for source (e.g. troubleshooting)
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
... payloadType Σ1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Types (extensible)
... payloadMimeType Σ0..*codeMimetype 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..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format

This structure is derived from Endpoint

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 11 elements
Fixed Value: 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..*EndpointThe technical details of an endpoint that can be used for electronic services
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase S0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase
... connectionType S1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types (extensible)
... name S0..1stringA name that this endpoint can be identified by
... managingOrganization S0..1Reference(Plan-Net Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact S0..*ContactPointContact details for source (e.g. troubleshooting)
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value S0..1stringThe actual contact point details
... payloadType S1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Types (extensible)
... payloadMimeType S0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
... address S1..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase S0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifies this endpoint across multiple systems
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types (extensible)
Min Binding: Minimum Endpoint Connection Types
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ0..1Reference(Plan-Net Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact S0..*ContactPointContact details for source (e.g. troubleshooting)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... period Σ0..1PeriodInterval the endpoint is expected to be operational
... payloadType SΣ1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Types (extensible)
... payloadMimeType SΣ0..*codeMimetype 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..1urlThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Endpoint.meta.securityextensibleAll Security Labels
Endpoint.meta.tagexampleCommonTags
Endpoint.languagepreferredCommonLanguages
Max Binding: AllLanguages
Endpoint.statusrequiredFixed Value: active
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Min Binding: Minimum Endpoint Connection Types
Endpoint.contact.systemrequiredContactPointSystem
Endpoint.contact.userequiredContactPointUse
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
Endpoint.payloadMimeTyperequiredMime Types