careMESH NPD - Local Development build (v0.1.0). See the Directory of published versions

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

Resource Profile: careMESH 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.

Usage:

• Examples for this Resource Profile: agamemnon@direct.mycenae.gov and Endpoint for Olympus of CT Portal

Formal Views of Profile Content

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

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

This structure is derived from PlannetEndpoint

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	PlannetEndpoint	The technical details of an endpoint that can be used for electronic services
name		1..1	string	A name that this endpoint can be identified by
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	PlannetEndpoint	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
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
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Σ	1..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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Endpoint.status	required	Fixed Value: active
Endpoint.connectionType	extensible	EndpointConnectionTypeVS Additional Bindings Purpose Minimum Endpoint Connection Types VS Min Binding
Endpoint.contact.system	required	ContactPointSystem
Endpoint.contact.use	required	ContactPointUse
Endpoint.payloadType	extensible	EndpointPayloadTypeVS
Endpoint.payloadMimeType	required	Mime Types (a valid code from urn:ietf:bcp:13)

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Endpoint	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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-4	error	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-5	error	Endpoint	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Endpoint	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	PlannetEndpoint	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags 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..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Σ	1..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
Endpoint.meta.security	extensible	All Security Labels
Endpoint.meta.tag	example	CommonTags
Endpoint.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Endpoint.status	required	Fixed Value: active
Endpoint.connectionType	extensible	EndpointConnectionTypeVS Additional Bindings Purpose Minimum Endpoint Connection Types VS Min Binding
Endpoint.contact.system	required	ContactPointSystem
Endpoint.contact.use	required	ContactPointUse
Endpoint.payloadType	extensible	EndpointPayloadTypeVS
Endpoint.payloadMimeType	required	Mime Types (a valid code from urn:ietf:bcp:13)

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from PlannetEndpoint

Summary

Mandatory: 1 element

Differential View

This structure is derived from PlannetEndpoint

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	PlannetEndpoint	The technical details of an endpoint that can be used for electronic services
name		1..1	string	A name that this endpoint can be identified by
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	PlannetEndpoint	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
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
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Σ	1..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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Endpoint.status	required	Fixed Value: active
Endpoint.connectionType	extensible	EndpointConnectionTypeVS Additional Bindings Purpose Minimum Endpoint Connection Types VS Min Binding
Endpoint.contact.system	required	ContactPointSystem
Endpoint.contact.use	required	ContactPointUse
Endpoint.payloadType	extensible	EndpointPayloadTypeVS
Endpoint.payloadMimeType	required	Mime Types (a valid code from urn:ietf:bcp:13)

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Endpoint	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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-4	error	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-5	error	Endpoint	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Endpoint	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	PlannetEndpoint	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags 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..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Σ	1..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
Endpoint.meta.security	extensible	All Security Labels
Endpoint.meta.tag	example	CommonTags
Endpoint.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Endpoint.status	required	Fixed Value: active
Endpoint.connectionType	extensible	EndpointConnectionTypeVS Additional Bindings Purpose Minimum Endpoint Connection Types VS Min Binding
Endpoint.contact.system	required	ContactPointSystem
Endpoint.contact.use	required	ContactPointUse
Endpoint.payloadType	extensible	EndpointPayloadTypeVS
Endpoint.payloadMimeType	required	Mime Types (a valid code from urn:ietf:bcp:13)

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from PlannetEndpoint

Summary

Mandatory: 1 element

Other representations of profile: CSV, Excel, Schematron