ITB Implementation Guide, published by . 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/espen-servicewell/wof-portal-fhir-ig/ and changes regularly. See the Directory of published versions

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

Resource Profile: ITB Endpoint

ITB Endpoint is used to handle ..

Usages:

• Examples for this Profile: FhirDataBaseEndPoint
• CapabilityStatements using this Profile: ITB capability statement

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
id	SΣ	1..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:extSourceSystemUserId	S	0..1	string	ITB Source System User Id Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extSourceSystemUserId
extension:StatusMessage	S	0..1	string	ExtEndpointStatusMessage URL: http://portal.wof.purified.link/fhir/StructureDefinition/ExtEndpointStatusMessage
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	Identifies this endpoint across multiple systems Slice: Unordered, Open by value:identifier
identifier:IdentifierPrefix	SΣ	0..1	Identifier	Identifies this endpoint across multiple systems
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: namingsystem/primarykey-prefix
identifier:DbContextId	SΣ	0..1	Identifier	Identifies this endpoint across multiple systems
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: namingsystem/sourcesystem-identifier
status	?!SΣ	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Σ	0..1	string	A name that this endpoint can be identified by
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): 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	S	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Endpoint.identifier:IdentifierPrefix.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Endpoint.identifier:DbContextId.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
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

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	S	1..1	id	Logical id of this artifact
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:extSourceSystemUserId	S	0..1	string	ITB Source System User Id Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extSourceSystemUserId
extension:StatusMessage	S	0..1	string	ExtEndpointStatusMessage URL: http://portal.wof.purified.link/fhir/StructureDefinition/ExtEndpointStatusMessage
Slices for identifier	S	0..*	Identifier	Identifies this endpoint across multiple systems Slice: Unordered, Open by value:identifier
identifier:IdentifierPrefix	S	0..1	Identifier	Identifies this endpoint across multiple systems
system		0..1	uri	The namespace for the identifier value Required Pattern: namingsystem/primarykey-prefix
identifier:DbContextId	S	0..1	Identifier	Identifies this endpoint across multiple systems
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://opusonfhir.wof.purified.link/CodeSystem/csIdentifierType
code		0..1	code	Symbol in syntax defined by the system Required Pattern: sourcesystem-identifier
system		0..1	uri	The namespace for the identifier value Required Pattern: namingsystem/sourcesystem-identifier
status	S	1..1	code	active | suspended | error | off | entered-in-error | test
connectionType	S	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection
name	S	0..1	string	A name that this endpoint can be identified by
payloadType	S	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
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
header	S	0..*	string	Usage depends on the channel type
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	SΣ	1..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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:extSourceSystemUserId	S	0..1	string	ITB Source System User Id Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extSourceSystemUserId
extension:StatusMessage	S	0..1	string	ExtEndpointStatusMessage URL: http://portal.wof.purified.link/fhir/StructureDefinition/ExtEndpointStatusMessage
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	Identifies this endpoint across multiple systems Slice: Unordered, Open by value:identifier
identifier:IdentifierPrefix	SΣ	0..1	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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: namingsystem/primarykey-prefix
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:DbContextId	SΣ	0..1	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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://opusonfhir.wof.purified.link/CodeSystem/csIdentifierType
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: sourcesystem-identifier
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: namingsystem/sourcesystem-identifier
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(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): 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Σ	0..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	Σ	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): 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	S	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.identifier:IdentifierPrefix.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Endpoint.identifier:IdentifierPrefix.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Endpoint.identifier:DbContextId.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Endpoint.identifier:DbContextId.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
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: 13 elements

Extensions

This structure refers to these extensions:

• http://portal.wof.purified.link/fhir/StructureDefinition/extSourceSystemUserId
• http://portal.wof.purified.link/fhir/StructureDefinition/ExtEndpointStatusMessage

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Endpoint.identifier

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
id	SΣ	1..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:extSourceSystemUserId	S	0..1	string	ITB Source System User Id Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extSourceSystemUserId
extension:StatusMessage	S	0..1	string	ExtEndpointStatusMessage URL: http://portal.wof.purified.link/fhir/StructureDefinition/ExtEndpointStatusMessage
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	Identifies this endpoint across multiple systems Slice: Unordered, Open by value:identifier
identifier:IdentifierPrefix	SΣ	0..1	Identifier	Identifies this endpoint across multiple systems
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: namingsystem/primarykey-prefix
identifier:DbContextId	SΣ	0..1	Identifier	Identifies this endpoint across multiple systems
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: namingsystem/sourcesystem-identifier
status	?!SΣ	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Σ	0..1	string	A name that this endpoint can be identified by
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): 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	S	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Endpoint.identifier:IdentifierPrefix.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Endpoint.identifier:DbContextId.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
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()

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
id	S	1..1	id	Logical id of this artifact
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:extSourceSystemUserId	S	0..1	string	ITB Source System User Id Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extSourceSystemUserId
extension:StatusMessage	S	0..1	string	ExtEndpointStatusMessage URL: http://portal.wof.purified.link/fhir/StructureDefinition/ExtEndpointStatusMessage
Slices for identifier	S	0..*	Identifier	Identifies this endpoint across multiple systems Slice: Unordered, Open by value:identifier
identifier:IdentifierPrefix	S	0..1	Identifier	Identifies this endpoint across multiple systems
system		0..1	uri	The namespace for the identifier value Required Pattern: namingsystem/primarykey-prefix
identifier:DbContextId	S	0..1	Identifier	Identifies this endpoint across multiple systems
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://opusonfhir.wof.purified.link/CodeSystem/csIdentifierType
code		0..1	code	Symbol in syntax defined by the system Required Pattern: sourcesystem-identifier
system		0..1	uri	The namespace for the identifier value Required Pattern: namingsystem/sourcesystem-identifier
status	S	1..1	code	active | suspended | error | off | entered-in-error | test
connectionType	S	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection
name	S	0..1	string	A name that this endpoint can be identified by
payloadType	S	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
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
header	S	0..*	string	Usage depends on the channel type
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	SΣ	1..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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:extSourceSystemUserId	S	0..1	string	ITB Source System User Id Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extSourceSystemUserId
extension:StatusMessage	S	0..1	string	ExtEndpointStatusMessage URL: http://portal.wof.purified.link/fhir/StructureDefinition/ExtEndpointStatusMessage
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	Identifies this endpoint across multiple systems Slice: Unordered, Open by value:identifier
identifier:IdentifierPrefix	SΣ	0..1	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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: namingsystem/primarykey-prefix
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:DbContextId	SΣ	0..1	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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://opusonfhir.wof.purified.link/CodeSystem/csIdentifierType
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: sourcesystem-identifier
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: namingsystem/sourcesystem-identifier
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(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): 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Σ	0..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	Σ	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): 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	S	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.identifier:IdentifierPrefix.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Endpoint.identifier:IdentifierPrefix.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Endpoint.identifier:DbContextId.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Endpoint.identifier:DbContextId.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
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: 13 elements

Extensions

This structure refers to these extensions:

• http://portal.wof.purified.link/fhir/StructureDefinition/extSourceSystemUserId
• http://portal.wof.purified.link/fhir/StructureDefinition/ExtEndpointStatusMessage

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Endpoint.identifier

Other representations of profile: CSV, Excel, Schematron