Endpoint

open class Endpoint: DomainResource

The technical details of an endpoint that can be used for electronic services.

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.

  • The technical details of an endpoint that can be used for electronic services.

    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.

    Declaration

    Swift

    override open class var resourceType: String

  • The technical base address for connecting to this endpoint.

    Declaration

    Swift

    public var address: FHIRURL?

  • Protocol/Profile/Standard to be used with this endpoint connection.

    Declaration

    Swift

    public var connectionType: Coding?

  • Contact details for source (e.g. troubleshooting).

    Declaration

    Swift

    public var contact: [ContactPoint]?

  • Usage depends on the channel type.

    Declaration

    Swift

    public var header: [FHIRString]?

  • Identifies this endpoint across multiple systems.

    Declaration

    Swift

    public var identifier: [Identifier]?

  • Organization that manages this endpoint (may not be the organization that exposes the endpoint).

    Declaration

    Swift

    public var managingOrganization: Reference?

  • A name that this endpoint can be identified by.

    Declaration

    Swift

    public var name: FHIRString?

  • Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this).

    Declaration

    Swift

    public var payloadMimeType: [FHIRString]?

  • The type of content that may be used at this endpoint (e.g. XDS Discharge summaries).

    Declaration

    Swift

    public var payloadType: [CodeableConcept]?

  • Interval the endpoint is expected to be operational.

    Declaration

    Swift

    public var period: Period?

  • active | suspended | error | off | test.

    Declaration

    Swift

    public var status: EndpointStatus?

  • Convenience initializer, taking all required properties as arguments.

    Declaration

    Swift

    public convenience init(address: FHIRURL, connectionType: Coding, payloadType: [CodeableConcept], status: EndpointStatus)

  • Convenience initializer, taking all required properties as arguments.

    Declaration

    Swift

    override open func populate(from json: FHIRJSON, context instCtx: inout FHIRInstantiationContext)

  • Undocumented

    Declaration

    Swift

    open class Endpoint: DomainResource