DaVinci PDEX Plan Net
0.3.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 0.3.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: PlannetEndpoint

The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.

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

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 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase
.... id S0..1stringUnique id for inter-element referencing
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... system S0..1uriThe namespace for the identifier value
.... value S0..1stringThe value that is unique
.... period S0..1PeriodTime period when id is/was valid for use
.... assigner S0..1Reference(Organization)Organization that issued id (may be just text)
... status S1..1codeactive | suspended | error | off | entered-in-error | test
Fixed Value: active
... connectionType S1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types (extensible)
Min Binding: Minimum Endpoint Connection Types
... 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)
.... contactpoint-availabletime S0..*(Complex)Extension
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
.... via-intermediary S0..*Reference(Plan-net PractitionerRole | Plan-net OrganizationAffiliation | Plan-net Location | Plan-net Organization)Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value S0..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
.... period S0..1PeriodTime period when the contact point was/is in use
... period S0..1PeriodInterval the endpoint is expected to be operational
... 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
... header S0..*stringUsage depends on the channel type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint I0..*EndpointThe technical details of an endpoint that can be used for electronic services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId ΣI0..1idVersion specific identifier
.... lastUpdated ΣI1..1instantWhen the resource version last changed
.... source ΣI0..1uriIdentifies where the resource comes from
.... profile ΣI0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security ΣI0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag ΣI0..*CodingTags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase I0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifies this endpoint across multiple systems
.... id S0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣI0..1stringThe value that is unique
Example General: 123456
.... period SΣI0..1PeriodTime period when id is/was valid for use
.... assigner SΣI0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣI1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required)
Fixed Value: active
... connectionType SΣI1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types (extensible)
Min Binding: Minimum Endpoint Connection Types
... name SΣI0..1stringA name that this endpoint can be identified by
... managingOrganization SΣI0..1Reference(Plan-net Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact SI0..*ContactPointContact details for source (e.g. troubleshooting)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime SI0..*(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
.... via-intermediary SI0..*Reference(Plan-net PractitionerRole | Plan-net OrganizationAffiliation | Plan-net Location | Plan-net Organization)Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣI0..1stringThe actual contact point details
.... use ?!SΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣI0..1PeriodTime period when the contact point was/is in use
... period SΣI0..1PeriodInterval the endpoint is expected to be operational
... payloadType SΣI1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Types (extensible)
... payloadMimeType SΣI0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required)
... address SΣI1..1urlThe technical base address for connecting to this endpoint
... header SI0..*stringUsage depends on the channel type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint I0..*EndpointThe technical details of an endpoint that can be used for electronic services
... identifier ΣI0..*IdentifierIdentifies this endpoint across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system ΣI0..1uriThe namespace for the identifier value
.... value ΣI0..1stringThe value that is unique
.... period ΣI0..1PeriodTime period when id is/was valid for use
.... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!ΣI1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required)
Fixed Value: active
... connectionType ΣI1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types (extensible)
Min Binding: Minimum Endpoint Connection Types
... managingOrganization ΣI0..1Reference(Plan-net Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact I0..*ContactPointContact details for source (e.g. troubleshooting)
.... contactpoint-availabletime I0..*(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
.... via-intermediary I0..*Reference(Plan-net PractitionerRole | Plan-net OrganizationAffiliation | Plan-net Location | Plan-net Organization)Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value ΣI0..1stringThe actual contact point details
.... use ?!ΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ΣI0..1PeriodTime period when the contact point was/is in use
... period ΣI0..1PeriodInterval the endpoint is expected to be operational
... payloadType ΣI1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Types (extensible)
... payloadMimeType ΣI0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required)
... address ΣI1..1urlThe technical base address for connecting to this endpoint
... header I0..*stringUsage depends on the channel type

doco Documentation for this format

This structure is derived from Endpoint

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 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase
.... id S0..1stringUnique id for inter-element referencing
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... system S0..1uriThe namespace for the identifier value
.... value S0..1stringThe value that is unique
.... period S0..1PeriodTime period when id is/was valid for use
.... assigner S0..1Reference(Organization)Organization that issued id (may be just text)
... status S1..1codeactive | suspended | error | off | entered-in-error | test
Fixed Value: active
... connectionType S1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types (extensible)
Min Binding: Minimum Endpoint Connection Types
... 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)
.... contactpoint-availabletime S0..*(Complex)Extension
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
.... via-intermediary S0..*Reference(Plan-net PractitionerRole | Plan-net OrganizationAffiliation | Plan-net Location | Plan-net Organization)Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value S0..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
.... period S0..1PeriodTime period when the contact point was/is in use
... period S0..1PeriodInterval the endpoint is expected to be operational
... 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
... header S0..*stringUsage depends on the channel type

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint I0..*EndpointThe technical details of an endpoint that can be used for electronic services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId ΣI0..1idVersion specific identifier
.... lastUpdated ΣI1..1instantWhen the resource version last changed
.... source ΣI0..1uriIdentifies where the resource comes from
.... profile ΣI0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security ΣI0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag ΣI0..*CodingTags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase I0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifies this endpoint across multiple systems
.... id S0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣI0..1stringThe value that is unique
Example General: 123456
.... period SΣI0..1PeriodTime period when id is/was valid for use
.... assigner SΣI0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣI1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required)
Fixed Value: active
... connectionType SΣI1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types (extensible)
Min Binding: Minimum Endpoint Connection Types
... name SΣI0..1stringA name that this endpoint can be identified by
... managingOrganization SΣI0..1Reference(Plan-net Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact SI0..*ContactPointContact details for source (e.g. troubleshooting)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime SI0..*(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
.... via-intermediary SI0..*Reference(Plan-net PractitionerRole | Plan-net OrganizationAffiliation | Plan-net Location | Plan-net Organization)Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣI0..1stringThe actual contact point details
.... use ?!SΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣI0..1PeriodTime period when the contact point was/is in use
... period SΣI0..1PeriodInterval the endpoint is expected to be operational
... payloadType SΣI1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Types (extensible)
... payloadMimeType SΣI0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required)
... address SΣI1..1urlThe technical base address for connecting to this endpoint
... header SI0..*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.identifier.userequiredIdentifierUse
Endpoint.identifier.typeextensibleIdentifier Type Codes
Endpoint.statusrequiredFixed Value: active
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Min Binding: Minimum Endpoint Connection Types
Endpoint.contact.systemrequiredContactPointSystem
Endpoint.contact.userequiredContactPointUse
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
Endpoint.payloadMimeTyperequiredMime Types