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.
Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)
- Value parameters:
- address
- The uri that describes the actual end-point to connect to.
- connectionType
- A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
- contact
- Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
- contained
- These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- extension
- May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- header
- Additional headers / information to send as part of the notification.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
- implicitRules
- A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- language
- The base language in which the resource is written.
- managingOrganization
- The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).
- meta
- The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- modifierExtension
- May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- name
- A friendly name that this endpoint can be referred to with.
- payloadMimeType
- The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
- payloadType
- The payload type describes the acceptable content that can be communicated on the endpoint.
- period
- The interval during which the endpoint is expected to be operational.
- status
- active | suspended | error | off | test.
- text
- A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- Constructor:
Introduces the fields name, status, period, header, contact, address, identifier, payloadType, connectionType, payloadMimeType, managingOrganization.
- Companion:
- object
Value members
Inherited methods
Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:
Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:
T
should not be a Choice[_], a LitSeq[_] or an Option[_]- It may require a type parameter sometimes (e.g.
sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET }
)
- Inherited from:
- FHIRObject
Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract
Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract
- Inherited from:
- FHIRObject
- Inherited from:
- Utils
- Inherited from:
- Utils
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.
Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.
- Inherited from:
- FHIRObject
Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^
Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^
- Inherited from:
- FHIRObject
Bit faster than >>
, but still much slower than using update$foo
when possible. If you must use it, then:
Bit faster than >>
, but still much slower than using update$foo
when possible. If you must use it, then:
T
should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject