This page is part of the SMART Health Cards and Links FHIR IG (v1.0.0: STU1) 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: SHL Endpoint

This profile defines constraints for an Endpoint to be utilized by a SMART Health Links Receiving Application, for example to launch a SMART on FHIR app or to provide another interactive user experience

Usages:

• Examples for this Profile: Review and comment on Alice's case in ACME Medical Diagnostic Portal and Labs-R-Us Application Access

You can also check for usages in the FHIR IG Statistics

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    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
connectionType	SΣ	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible)
name	SΣ	1..1	string	A name that this endpoint can be identified by
period	SΣ	0..1	Period	Interval the endpoint is expected to be operational
payloadType	Σ	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example)
address	SΣ	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Endpoint.status	required	EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 From the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionType http://hl7.org/fhir/ValueSet/endpoint-connection-type From the FHIR Standard
Endpoint.payloadType	example	EndpointPayloadType http://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard

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()

This structure is derived from Endpoint

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services
connectionType	S	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection
name	S	1..1	string	A name that this endpoint can be identified by
period	S	0..1	Period	Interval the endpoint is expected to be operational
address	S	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifies this endpoint across multiple systems
status	?!Σ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
connectionType	SΣ	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible)
name	SΣ	1..1	string	A name that this endpoint can be identified by
managingOrganization	Σ	0..1	Reference(Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
contact		0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
period	SΣ	0..1	Period	Interval the endpoint is expected to be operational
payloadType	Σ	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example)
payloadMimeType	Σ	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	URI
Endpoint.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Endpoint.status	required	EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 From the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionType http://hl7.org/fhir/ValueSet/endpoint-connection-type From the FHIR Standard
Endpoint.payloadType	example	EndpointPayloadType http://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard
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

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()

This structure is derived from Endpoint

Summary

Mandatory: 1 element
Must-Support: 4 elements

Maturity: 4

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
connectionType	SΣ	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible)
name	SΣ	1..1	string	A name that this endpoint can be identified by
period	SΣ	0..1	Period	Interval the endpoint is expected to be operational
payloadType	Σ	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example)
address	SΣ	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Endpoint.status	required	EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 From the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionType http://hl7.org/fhir/ValueSet/endpoint-connection-type From the FHIR Standard
Endpoint.payloadType	example	EndpointPayloadType http://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard

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()

Differential View

This structure is derived from Endpoint

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services
connectionType	S	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection
name	S	1..1	string	A name that this endpoint can be identified by
period	S	0..1	Period	Interval the endpoint is expected to be operational
address	S	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifies this endpoint across multiple systems
status	?!Σ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
connectionType	SΣ	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible)
name	SΣ	1..1	string	A name that this endpoint can be identified by
managingOrganization	Σ	0..1	Reference(Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
contact		0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
period	SΣ	0..1	Period	Interval the endpoint is expected to be operational
payloadType	Σ	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example)
payloadMimeType	Σ	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	URI
Endpoint.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Endpoint.status	required	EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 From the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionType http://hl7.org/fhir/ValueSet/endpoint-connection-type From the FHIR Standard
Endpoint.payloadType	example	EndpointPayloadType http://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard
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

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()

This structure is derived from Endpoint

Summary

Mandatory: 1 element
Must-Support: 4 elements

Maturity: 4

Other representations of profile: CSV, Excel, Schematron