FhirEndpoint class

FhirEndpoint The technical details of an endpoint that can be used for

Mixed in types

• Resource

Annotations

• @freezed

Constructors

FhirEndpoint({@Default(R4ResourceType.Endpoint) @JsonKey(unknownEnumValue: R4ResourceType.Endpoint) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<Resource>? contained, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, List<Identifier>? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, required Coding connectionType, String? name, @JsonKey(name: '_name') Element? nameElement, Reference? managingOrganization, List<ContactPoint>? contact, Period? period, required List<CodeableConcept> payloadType, List<FhirCode>? payloadMimeType, @JsonKey(name: '_payloadMimeType') List<Element?>? payloadMimeTypeElement, FhirUrl? address, @JsonKey(name: '_address') Element? addressElement, List<String>? header, @JsonKey(name: '_header') List<Element?>? headerElement})

FhirEndpoint 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.

const

factory

FhirEndpoint.fromJson(Map<String, dynamic> json)

Factory constructor, accepts Map<String, dynamic> as an argument

factory

FhirEndpoint.fromJsonString(String source)

Acts like a constructor, returns a FhirEndpoint, accepts a String as an argument, mostly because I got tired of typing it out

factory

FhirEndpoint.fromYaml(dynamic yaml)

Factory constructor that accepts a String in YAML format as an argument

factory

Properties

address → FhirUrl?

address The uri that describes the actual end-point to connect to.

no setter, inherited

addressElement → Element?

addressElement Extensions for address

no setter, inherited

connectionType → Coding

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).

no setter, inherited

contact → List<ContactPoint>?

contact Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

no setter, inherited

contained → List<Resource>?

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.

no setter, inherited

copyWith → $FhirEndpointCopyWith<FhirEndpoint>

no setter, inherited

dbId → int?

no setter, inherited

extension_ → List<FhirExtension>?

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.

no setter, inherited

fhirId → String?

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

header → List<String>?

header Additional headers / information to send as part of the notification.

no setter, inherited

headerElement → List<Element?>?

headerElement Extensions for header

no setter, inherited

identifier → List<Identifier>?

identifier Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

no setter, inherited

implicitRules → FhirUri?

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.

no setter, inherited

implicitRulesElement → Element?

implicitRulesElement Extensions for implicitRules

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement Extensions for language

no setter, inherited

managingOrganization → Reference?

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).

no setter, inherited

meta → FhirMeta?

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.

no setter, inherited

modifierExtension → List<FhirExtension>?

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).

no setter, inherited

name → String?

name A friendly name that this endpoint can be referred to with.

no setter, inherited

nameElement → Element?

nameElement Extensions for name

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

payloadMimeType → List<FhirCode>?

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).

no setter, inherited

payloadMimeTypeElement → List<Element?>?

payloadMimeTypeElement Extensions for payloadMimeType

no setter, inherited

payloadType → List<CodeableConcept>

payloadType The payload type describes the acceptable content that can be communicated on the endpoint.

no setter, inherited

period → Period?

period The interval during which the endpoint is expected to be operational.

no setter, inherited

resourceType → R4ResourceType

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → FhirCode?

status active | suspended | error | off | test.

no setter, inherited

statusElement → Element?

statusElement Extensions for status

no setter, inherited

text → Narrative?

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.

no setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

Methods

newId() → Resource

returns the same resource with a new ID (even if there is already an ID present)

inherited

newIdIfNoId() → Resource

returns the same resource with a new ID if there is no current ID

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDbJson() → Map<String, dynamic>

The normal toJson ignores the dbId, and produces the fhirId as the id However, if you're going to use this as a database entry, you have to switch those two ids

inherited

toJson() → Map<String, dynamic>

inherited

toJsonString() → String

Another convenience method because more and more I'm transmitting FHIR data as a String and not a Map

override

toString() → String

A string representation of this object.

inherited

toYaml() → String

Produces a Yaml formatted String version of the object

inherited

updateContactPointPeriod(Period period, [int index = 0]) → FhirEndpoint

updateContactPointRank(FhirPositiveInt rank, [int index = 0]) → FhirEndpoint

updateContactPointSystem(ContactPointSystem system, [int index = 0]) → FhirEndpoint

updateContactPointUse(ContactPointUse use, [int index = 0]) → FhirEndpoint

updateContactPointValue(String value, [int index = 0]) → FhirEndpoint

updateVersion({FhirMeta? oldMeta}) → Resource

Updates the meta field of this Resource, updates the meta.lastUpdated field, adds 1 to the version number

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited