Skip to main content

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.

Properties

NameCardTypeDescription
id0..1stringLogical id of this artifact
meta0..1MetaMetadata about the resource
implicitRules0..1uriA set of rules under which this content was created
language0..1codeLanguage of the resource content
text0..1NarrativeText summary of the resource, for human interpretation
contained0..*ResourceContained, inline Resources
extension0..*ExtensionAdditional content defined by implementations
modifierExtension0..*ExtensionExtensions that cannot be ignored
identifier0..*IdentifierIdentifies this endpoint across multiple systems
status1..1codeactive | suspended | error | off | entered-in-error | test
connectionType1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
name0..1stringA name that this endpoint can be identified by
managingOrganization0..1ReferenceOrganization that manages this endpoint (might not be the organization that exposes the endpoint)
contact0..*ContactPointContact details for source (e.g. troubleshooting)
period0..1PeriodInterval the endpoint is expected to be operational
payloadType1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
payloadMimeType0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
address1..1urlThe technical base address for connecting to this endpoint
header0..*stringUsage depends on the channel type

Search Parameters

NameTypeDescriptionExpression
connection-typetokenProtocol/Profile/Standard to be used with this endpoint connectionEndpoint.connectionType
identifiertokenIdentifies this endpoint across multiple systemsEndpoint.identifier
namestringA name that this endpoint can be identified byEndpoint.name
organizationreferenceThe organization that is managing the endpointEndpoint.managingOrganization
payload-typetokenThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)Endpoint.payloadType
statustokenThe current status of the Endpoint (usually expected to be active)Endpoint.status