FhirEndpoint constructor

const FhirEndpoint({
  1. @Default(R5ResourceType.Endpoint) @JsonKey(unknownEnumValue: R5ResourceType.Endpoint) R5ResourceType resourceType,
  2. @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
  3. @JsonKey(name: 'id') FhirId? fhirId,
  4. FhirMeta? meta,
  5. FhirUri? implicitRules,
  6. @JsonKey(name: '_implicitRules') Element? implicitRulesElement,
  7. FhirCode? language,
  8. @JsonKey(name: '_language') Element? languageElement,
  9. Narrative? text,
  10. List<Resource>? contained,
  11. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  12. List<FhirExtension>? modifierExtension,
  13. List<Identifier>? identifier,
  14. FhirCode? status,
  15. @JsonKey(name: '_status') Element? statusElement,
  16. required List<CodeableConcept> connectionType,
  17. String? name,
  18. @JsonKey(name: '_name') Element? nameElement,
  19. String? description,
  20. @JsonKey(name: '_description') Element? descriptionElement,
  21. List<CodeableConcept>? environmentType,
  22. Reference? managingOrganization,
  23. List<ContactPoint>? contact,
  24. Period? period,
  25. List<FhirEndpointPayload>? payload,
  26. FhirUrl? address,
  27. @JsonKey(name: '_address') Element? addressElement,
  28. List<String>? header,
  29. @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, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information.

resourceType This is a Endpoint resource

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

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.

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.

implicitRulesElement ("_implicitRules") Extensions for implicitRules

language The base language in which the resource is written.

languageElement ("_language") Extensions for language

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.

contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

extension_ ("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 managable, 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.

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

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

status The endpoint status represents the general expected availability of an endpoint.

statusElement ("_status") Extensions for status

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

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

nameElement ("_name") Extensions for name

description The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose).

descriptionElement ("_description") Extensions for description

environmentType The type of environment(s) exposed at this endpoint (dev, prod, test, etc.).

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

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

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

payload The set of payloads that are provided/available at this endpoint.

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

addressElement ("_address") Extensions for address

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

headerElement ("_header") Extensions for header

Implementation

const factory FhirEndpoint({
  /// [resourceType] This is a Endpoint resource
  @Default(R5ResourceType.Endpoint)
  @JsonKey(unknownEnumValue: R5ResourceType.Endpoint)
  R5ResourceType resourceType,
  @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,

  /// [id] The logical id of the resource, as used in the URL for the
  ///  resource. Once assigned, this value never changes.
  @JsonKey(name: 'id') FhirId? fhirId,

  /// [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.
  FhirMeta? meta,

  /// [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.
  FhirUri? implicitRules,

  /// [implicitRulesElement] ("_implicitRules") Extensions for implicitRules
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

  /// [language] The base language in which the resource is written.
  FhirCode? language,

  /// [languageElement] ("_language") Extensions for language
  @JsonKey(name: '_language') Element? languageElement,

  /// [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.
  Narrative? text,

  /// [contained] These resources do not have an independent existence apart
  ///  from the resource that contains them - they cannot be identified
  ///  independently, nor can they have their own independent transaction
  ///  scope. This is allowed to be a Parameters resource if and only if it
  ///  is referenced by a resource that provides context/meaning.
  List<Resource>? contained,

  /// [extension_] ("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 managable, 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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [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 managable, 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).
  List<FhirExtension>? modifierExtension,

  /// [identifier] Identifier for the organization that is used to identify
  ///  the endpoint across multiple disparate systems.
  List<Identifier>? identifier,

  /// [status] The endpoint status represents the general expected
  ///  availability of an endpoint.
  FhirCode? status,

  /// [statusElement] ("_status") Extensions for status
  @JsonKey(name: '_status') Element? statusElement,

  /// [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).
  required List<CodeableConcept> connectionType,

  /// [name] A friendly name that this endpoint can be referred to with.
  String? name,

  /// [nameElement] ("_name") Extensions for name
  @JsonKey(name: '_name') Element? nameElement,

  /// [description] The description of the endpoint and what it is for
  ///  (typically used as supplemental information in an endpoint directory
  ///  describing its usage/purpose).
  String? description,

  /// [descriptionElement] ("_description") Extensions for description
  @JsonKey(name: '_description') Element? descriptionElement,

  /// [environmentType] The type of environment(s) exposed at this endpoint
  ///  (dev, prod, test, etc.).
  List<CodeableConcept>? environmentType,

  /// [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).
  Reference? managingOrganization,

  /// [contact] Contact details for a human to contact about the endpoint.
  ///  The primary use of this for system administrator troubleshooting.
  List<ContactPoint>? contact,

  /// [period] The interval during which the endpoint is expected to be
  ///  operational.
  Period? period,

  /// [payload] The set of payloads that are provided/available at this
  ///  endpoint.
  List<FhirEndpointPayload>? payload,

  /// [address] The uri that describes the actual end-point to connect to.
  FhirUrl? address,

  /// [addressElement] ("_address") Extensions for address
  @JsonKey(name: '_address') Element? addressElement,

  /// [header] Additional headers / information to send as part of the
  ///  notification.
  List<String>? header,

  /// [headerElement] ("_header") Extensions for header
  @JsonKey(name: '_header') List<Element>? headerElement,
}) = _FhirEndpoint;