FhirRequest.history constructor

const FhirRequest.history({ required Uri base, required R4ResourceType type, required String fhirId, @Default(false) bool pretty, @Default(Summary.none) Summary summary, @Default('json') String format, @Default(<String>[]) List<String> elements, @Default(<String>[]) List<String> parameters, int? count, FhirInstant? since, FhirDateTime? at, String? reference, MimeType? mimeType, @Default('application/fhir+json') String accept, @JsonKey(includeFromJson: false, includeToJson: false) Client? client, Map<String, String>? headers, })

HISTORY constructor base - the base URI for the FHIR server type - the type of resource you're looking for fhirId - the id for the resource pretty - pretty print the json formatting in the response summary - do you want the result to be a summary format - currently requests json, but could consider requesting json+fhir or fhir+json (would not request XML as this library doesn't work with XML) elements - elements you need to pass in parameters - any extra parameters count - The maximum number of search results on a page, excluding related resources included by _include or _revinclude or OperationOutcomes. The server is not bound to return the number requested, but cannot return more since - Only include resource versions that were created at or after the given instant in time at - Only include resource versions that were current at some point during the time period specified in the date time value reference - Only include resource versions that are referenced in the specified list mimeType - specify the MimeType in the Header - this should be fhir+json but there are some older systems that won't accept that client - if there's a specific client that you're going to be using

Implementation

const factory FhirRequest.history({
  /// [base] - the base URI for the FHIR server
  required Uri base,

  /// [type] - the type of resource you're looking for
  required R4ResourceType type,

  /// [fhirId] - the id for the resource
  required String fhirId,

  /// [pretty] - pretty print the json formatting in the response
  @Default(false) bool pretty,

  /// [summary] - do you want the result to be a summary
  @Default(Summary.none) Summary summary,

  /// [format] - currently requests json, but could consider requesting
  ///   json+fhir or fhir+json (would not request XML as this library doesn't
  ///   work with XML)
  @Default('json') String format,

  /// [elements] - elements you need to pass in
  @Default(<String>[]) List<String> elements,

  /// [parameters] - any extra parameters
  @Default(<String>[]) List<String> parameters,

  /// [count] - The maximum number of search results on a page, excluding related
  ///   resources included by _include or _revinclude or OperationOutcomes. The
  ///   server is not bound to return the number requested, but cannot return more
  int? count,

  /// [since] - Only include resource versions that were created at or after the
  ///   given instant in time
  FhirInstant? since,

  /// [at] - Only include resource versions that were current at some point
  ///   during the time period specified in the date time value
  FhirDateTime? at,

  /// [reference] - Only include resource versions that are referenced in
  ///   the specified list
  String? reference,

  /// [mimeType] - specify the MimeType in the Header - this should be fhir+json
  ///   but there are some older systems that won't accept that
  MimeType? mimeType,

  /// [accept] - this will default to fhir+json just so it will stop sending
  /// me XML - I hate XML
  @Default('application/fhir+json') String accept,

  /// [client] - if there's a specific client that you're going to be using
  // ignore: invalid_annotation_target
  @JsonKey(includeFromJson: false, includeToJson: false) Client? client,

  /// [headers] - because there are some times it's easier to incldue the
  /// headers in the object instead of only passing it in with the
  /// request
  Map<String, String>? headers,
}) = FhirHistoryRequest;