This page is part of the DaVinci PDEX Plan Net (v1.2.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Plan-Net Endpoint

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.

Usage:

• Refer to this Resource Profile: Plan-Net HealthcareService, Plan-Net InsurancePlan, Plan-Net Location, Plan-Net Network... Show 2 more, Plan-Net OrganizationAffiliation and Plan-Net PractitionerRole
• Examples for this Resource Profile: Endpoint for Acme of CT Portal
• CapabilityStatements using this Resource Profile: Plan-Net CapabilityStatement

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
endpoint-usecase	S	0..*	(Complex)	Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!SΣ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. ele-1: All FHIR elements must have a @value or children 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 Bindings Purpose Minimum Endpoint Connection Types VS Min Binding ele-1: All FHIR elements must have a @value or children
name	SΣ	0..1	string	A name that this endpoint can be identified by ele-1: All FHIR elements must have a @value or children
managingOrganization	SΣ	0..1	Reference(Plan-Net Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint) ele-1: All FHIR elements must have a @value or children
contact	S	0..*	ContactPoint	Contact details for source (e.g. troubleshooting) ele-1: All FHIR elements must have a @value or children
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	0..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
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) ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
address	SΣ	1..1	url	The technical base address for connecting to this endpoint ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Endpoint.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointConnectionTypeVS from this IG Additional Bindings Purpose Minimum Endpoint Connection Types VS Min Binding
Endpoint.contact.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Endpoint.contact.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Endpoint.payloadType	extensible	EndpointPayloadTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointPayloadTypeVS from this IG
Endpoint.payloadMimeType	required	Mime 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

Name	Flags	Card.	Type	Description & Constraints
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
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 Bindings Purpose 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	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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Endpoint.connectionType	extensible	EndpointConnectionTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointConnectionTypeVS from this IG Additional Bindings Purpose Minimum Endpoint Connection Types VS Min Binding
Endpoint.payloadType	extensible	EndpointPayloadTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointPayloadTypeVS from this IG

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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 Bindings Purpose 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Endpoint.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Endpoint.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointConnectionTypeVS from this IG Additional Bindings Purpose Minimum Endpoint Connection Types VS Min Binding
Endpoint.contact.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Endpoint.contact.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Endpoint.payloadType	extensible	EndpointPayloadTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointPayloadTypeVS from this IG
Endpoint.payloadMimeType	required	Mime 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

Must-Support: 11 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• Plan-Net Organization (http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
endpoint-usecase	S	0..*	(Complex)	Endpoint Usecase URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!SΣ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. ele-1: All FHIR elements must have a @value or children 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 Bindings Purpose Minimum Endpoint Connection Types VS Min Binding ele-1: All FHIR elements must have a @value or children
name	SΣ	0..1	string	A name that this endpoint can be identified by ele-1: All FHIR elements must have a @value or children
managingOrganization	SΣ	0..1	Reference(Plan-Net Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint) ele-1: All FHIR elements must have a @value or children
contact	S	0..*	ContactPoint	Contact details for source (e.g. troubleshooting) ele-1: All FHIR elements must have a @value or children
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	0..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
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) ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
address	SΣ	1..1	url	The technical base address for connecting to this endpoint ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Endpoint.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointConnectionTypeVS from this IG Additional Bindings Purpose Minimum Endpoint Connection Types VS Min Binding
Endpoint.contact.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Endpoint.contact.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Endpoint.payloadType	extensible	EndpointPayloadTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointPayloadTypeVS from this IG
Endpoint.payloadMimeType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

Differential View

This structure is derived from Endpoint

Name	Flags	Card.	Type	Description & Constraints
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
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 Bindings Purpose 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	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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Endpoint.connectionType	extensible	EndpointConnectionTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointConnectionTypeVS from this IG Additional Bindings Purpose Minimum Endpoint Connection Types VS Min Binding
Endpoint.payloadType	extensible	EndpointPayloadTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointPayloadTypeVS from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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 Bindings Purpose 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Endpoint.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Endpoint.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointConnectionTypeVS from this IG Additional Bindings Purpose Minimum Endpoint Connection Types VS Min Binding
Endpoint.contact.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Endpoint.contact.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Endpoint.payloadType	extensible	EndpointPayloadTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/EndpointPayloadTypeVS from this IG
Endpoint.payloadMimeType	required	Mime 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

Must-Support: 11 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• Plan-Net Organization (http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase

Other representations of profile: CSV, Excel, Schematron