DaVinci PDEX Plan Net STU Ballot
This page is part of the DaVinci PDEX Plan Net (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint
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.
This profile builds on Endpoint.
This profile was published on Wed Oct 23 00:00:00 EDT 2019 as a draft by HL7 Financial Management WG.
Summary
Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 23 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Mapping Source
This structure represents the following mapping definition:
plannet.Endpoint maps to Endpoint: ManagingOrganization maps to managingOrganization UseCase maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase constrain contact.system to 1..1 constrain contact.value to 1..1 EndpointContact maps to contact PN_Identifier.IdentifierUse maps to identifier.use PN_Identifier.IdentifierSystem maps to identifier.system PN_Identifier.IdentifierValue maps to identifier.value PN_Identifier.IdentifierType maps to identifier.type PN_Identifier.IdentifierPeriod maps to identifier.period PN_Identifier.IdentifierAssigner maps to identifier.assigner EndpointContact.ContactPoint.Purpose maps to contact.use EndpointContact.ContactPoint.Type maps to contact.system EndpointContact.ContactPoint.PriorityRank maps to contact.rank EndpointContact.ContactPoint.EffectiveTimePeriod maps to contact.period EndpointContact.ContactPoint.TelecomNumberOrAddress maps to contact.value EndpointStatus maps to status ConnectionType maps to connectionType EndpointName maps to name CAvailableTime maps to contact.extension CViaIntermediary maps to contact.extension Period maps to period PayloadType maps to payloadType PayloadMimeType maps to payloadMimeType EndpointAddress maps to address EndpointHeader maps to header
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Endpoint | plannet-Endpoint | |||
  extension | Slice: Unordered, Open by value:url | |||
 endpoint-usecase | S | 0..* | (Complex) | Use case URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase |
| identifier | ||||
 use | S | |||
| type | S | |||
| system | S | |||
| value | S | |||
| period | S | |||
  assigner | S | Reference(plannet-Organization) | ||
| status | S | |||
| connectionType | S | |||
| name | S | |||
| managingOrganization | S | Reference(plannet-Organization) | ||
| contact | 0..1 | |||
| contactpoint-availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
| plannet-CViaIntermediary-extension | S | 0..1 | Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location) | CViaIntermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension |
| system | S | 1..1 | ||
| value | S | 1..1 | ||
| use | S | |||
| rank | S | |||
| period | S | |||
| period | S | |||
| payloadType | S | |||
| payloadMimeType | S | |||
| address | S | |||
| header | S | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | I | 0..* | plannet-Endpoint | |
 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
 contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| endpoint-usecase | S | 0..* | (Complex) | Use case URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Identifies this endpoint across multiple systems |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| period | SΣ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | SΣ | 0..1 | Reference(plannet-Organization) | Organization that issued id (may be just text) |
| status | ?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required) |
| connectionType | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) |
| name | SΣ | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | SΣ | 0..1 | Reference(plannet-Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| contact | 0..1 | 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 | |
| contactpoint-availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
| plannet-CViaIntermediary-extension | S | 0..1 | Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location) | CViaIntermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension |
| system | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
| value | SΣ | 1..1 | string | The actual contact point details |
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
| period | SΣ | 0..1 | Period | Interval the endpoint is expected to be operational |
| payloadType | SΣ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) |
| 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) |
| address | SΣ | 1..1 | url | The technical base address for connecting to this endpoint |
| header | S | 0..* | string | Usage depends on the channel type |
| Documentation for this format | ||||
Summary
Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 23 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Mapping Source
This structure represents the following mapping definition:
plannet.Endpoint maps to Endpoint: ManagingOrganization maps to managingOrganization UseCase maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase constrain contact.system to 1..1 constrain contact.value to 1..1 EndpointContact maps to contact PN_Identifier.IdentifierUse maps to identifier.use PN_Identifier.IdentifierSystem maps to identifier.system PN_Identifier.IdentifierValue maps to identifier.value PN_Identifier.IdentifierType maps to identifier.type PN_Identifier.IdentifierPeriod maps to identifier.period PN_Identifier.IdentifierAssigner maps to identifier.assigner EndpointContact.ContactPoint.Purpose maps to contact.use EndpointContact.ContactPoint.Type maps to contact.system EndpointContact.ContactPoint.PriorityRank maps to contact.rank EndpointContact.ContactPoint.EffectiveTimePeriod maps to contact.period EndpointContact.ContactPoint.TelecomNumberOrAddress maps to contact.value EndpointStatus maps to status ConnectionType maps to connectionType EndpointName maps to name CAvailableTime maps to contact.extension CViaIntermediary maps to contact.extension Period maps to period PayloadType maps to payloadType PayloadMimeType maps to payloadMimeType EndpointAddress maps to address EndpointHeader maps to header
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | plannet-Endpoint | |||
| extension | Slice: Unordered, Open by value:url | |||
| endpoint-usecase | S | 0..* | (Complex) | Use case URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase |
| identifier | ||||
| use | S | |||
| type | S | |||
| system | S | |||
| value | S | |||
| period | S | |||
| assigner | S | Reference(plannet-Organization) | ||
| status | S | |||
| connectionType | S | |||
| name | S | |||
| managingOrganization | S | Reference(plannet-Organization) | ||
| contact | 0..1 | |||
| contactpoint-availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
| plannet-CViaIntermediary-extension | S | 0..1 | Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location) | CViaIntermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension |
| system | S | 1..1 | ||
| value | S | 1..1 | ||
| use | S | |||
| rank | S | |||
| period | S | |||
| period | S | |||
| payloadType | S | |||
| payloadMimeType | S | |||
| address | S | |||
| header | S | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | I | 0..* | plannet-Endpoint | |
| 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| endpoint-usecase | S | 0..* | (Complex) | Use case URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Identifies this endpoint across multiple systems |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| period | SΣ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | SΣ | 0..1 | Reference(plannet-Organization) | Organization that issued id (may be just text) |
| status | ?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required) |
| connectionType | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) |
| name | SΣ | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | SΣ | 0..1 | Reference(plannet-Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| contact | 0..1 | 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 | |
| contactpoint-availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
| plannet-CViaIntermediary-extension | S | 0..1 | Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location) | CViaIntermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension |
| system | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
| value | SΣ | 1..1 | string | The actual contact point details |
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
| period | SΣ | 0..1 | Period | Interval the endpoint is expected to be operational |
| payloadType | SΣ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) |
| 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) |
| address | SΣ | 1..1 | url | The technical base address for connecting to this endpoint |
| header | S | 0..* | string | Usage depends on the channel type |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
| Path | Conformance | ValueSet |
| Endpoint.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Endpoint.identifier.use | required | IdentifierUse |
| Endpoint.identifier.type | extensible | Identifier Type Codes |
| Endpoint.status | required | EndpointStatus |
| Endpoint.connectionType | extensible | EndpointConnectionType |
| Endpoint.contact.system | required | ContactPointSystem |
| Endpoint.contact.use | required | ContactPointUse |
| Endpoint.payloadType | example | EndpointPayloadType |
| Endpoint.payloadMimeType | required | Mime Types |
| Id | Path | Details | Requirements |
| dom-2 | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-4 | Endpoint | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-3 | Endpoint | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-6 | Endpoint | A resource should have narrative for robust management : text.div.exists() | |
| dom-5 | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
©2019+
HL7 Financial Management WG.
Package hl7.fhir.us.davinci-pdex-plan-net#0.1.0 based on FHIR 4.0.0.
Generated 2019-10-24.
Links:
Home
| QA Report | Search
|
Version History
|
|
Propose a change