HL7® Austria TC FHIR® Messaging, published by HL7® Austria, TC FHIR®. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7Austria/TC-FHIR-AG-Messaging-R5/ and changes regularly. See the Directory of published versions

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

Resource Profile: AT Messaging Endpoint

Endpoint for use in the Messaging systems for AT FHIR messaging.

Usages:

• Refer to this Profile: AT Messaging Message Header

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
contained		0..*	Resource	Contained, inline Resources
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	Σ	1..1	CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection Binding: AT Messaging Endpoint Type ValueSet (preferred)
address	SΣ	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Endpoint.status	Base	required	Endpoint Status	📍5.0.0	FHIR Std.
Endpoint.connectionType	Base	preferred	AT Messaging Endpoint Type ValueSet	📦0.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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		1..1	CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection Binding: AT Messaging Endpoint Type ValueSet (preferred)
address	S	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Endpoint.connectionType	Base	preferred	AT Messaging Endpoint Type ValueSet	📦0.1.0	This IG

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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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	Σ	1..1	CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection Binding: AT Messaging Endpoint Type ValueSet (preferred)
name	Σ	0..1	string	A name that this endpoint can be identified by
description	Σ	0..1	string	Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
environmentType	Σ	0..*	CodeableConcept	The type of environment(s) exposed at this endpoint Binding: EndpointEnvironment (extensible)
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	Σ	0..1	Period	Interval the endpoint is expected to be operational
payload		0..*	BackboneElement	Set of payloads that are provided by this endpoint
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example)
mimeType	Σ	0..*	code	Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
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	Status	Usage	ValueSet	Version	Source
Endpoint.language	Base	required	All Languages	📍5.0.0	FHIR Std.
Endpoint.status	Base	required	Endpoint Status	📍5.0.0	FHIR Std.
Endpoint.connectionType	Base	preferred	AT Messaging Endpoint Type ValueSet	📦0.1.0	This IG
Endpoint.environmentType	Base	extensible	Endpoint Environment	📍5.0.0	FHIR Std.
Endpoint.payload.type	Base	example	Endpoint Payload Type	📍5.0.0	FHIR Std.
Endpoint.payload.mimeType	Base	required	Mime Types	📍5.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

Must-Support: 1 element

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
contained		0..*	Resource	Contained, inline Resources
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	Σ	1..1	CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection Binding: AT Messaging Endpoint Type ValueSet (preferred)
address	SΣ	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Endpoint.status	Base	required	Endpoint Status	📍5.0.0	FHIR Std.
Endpoint.connectionType	Base	preferred	AT Messaging Endpoint Type ValueSet	📦0.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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		1..1	CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection Binding: AT Messaging Endpoint Type ValueSet (preferred)
address	S	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Endpoint.connectionType	Base	preferred	AT Messaging Endpoint Type ValueSet	📦0.1.0	This IG

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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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	Σ	1..1	CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection Binding: AT Messaging Endpoint Type ValueSet (preferred)
name	Σ	0..1	string	A name that this endpoint can be identified by
description	Σ	0..1	string	Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
environmentType	Σ	0..*	CodeableConcept	The type of environment(s) exposed at this endpoint Binding: EndpointEnvironment (extensible)
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	Σ	0..1	Period	Interval the endpoint is expected to be operational
payload		0..*	BackboneElement	Set of payloads that are provided by this endpoint
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example)
mimeType	Σ	0..*	code	Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
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	Status	Usage	ValueSet	Version	Source
Endpoint.language	Base	required	All Languages	📍5.0.0	FHIR Std.
Endpoint.status	Base	required	Endpoint Status	📍5.0.0	FHIR Std.
Endpoint.connectionType	Base	preferred	AT Messaging Endpoint Type ValueSet	📦0.1.0	This IG
Endpoint.environmentType	Base	extensible	Endpoint Environment	📍5.0.0	FHIR Std.
Endpoint.payload.type	Base	example	Endpoint Payload Type	📍5.0.0	FHIR Std.
Endpoint.payload.mimeType	Base	required	Mime Types	📍5.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

Must-Support: 1 element

Other representations of profile: CSV, Excel, Schematron