From 81911ab2d713e2968c8f209911abab91f472a9e5 Mon Sep 17 00:00:00 2001 From: SDKAuto Date: Wed, 31 Jan 2024 20:23:08 +0000 Subject: [PATCH] CodeGen from PR 27223 in Azure/azure-rest-api-specs Merge e734ee1792a8c5b8a4cd5997b6a9db9ee5f52ee3 into f3cd6922dbe117d78b4f719bbf8b03db46b30808 --- .../_meta.json | 6 + .../healthinsights/cancerprofiling/_client.py | 32 +- .../cancerprofiling/_configuration.py | 17 +- .../cancerprofiling/_model_base.py | 436 +- .../_operations/_operations.py | 2375 ++- .../cancerprofiling/_serialization.py | 89 +- .../healthinsights/cancerprofiling/_types.py | 12 + .../cancerprofiling/aio/_client.py | 30 +- .../cancerprofiling/aio/_configuration.py | 17 +- .../aio/_operations/_operations.py | 2346 ++- .../cancerprofiling/models/__init__.py | 58 +- .../cancerprofiling/models/_enums.py | 50 +- .../cancerprofiling/models/_models.py | 1564 +- .../sample_infer_cancer_profiling_async.py | 57 +- .../samples/sample_infer_cancer_profiling.py | 48 +- .../setup.py | 13 +- .../tests/conftest.py | 4 +- .../tests/test_cancer_profiling.py | 41 +- .../tsp-location.yaml | 7 + .../_meta.json | 6 + .../clinicalmatching/_client.py | 28 +- .../clinicalmatching/_configuration.py | 17 +- .../clinicalmatching/_model_base.py | 440 +- .../_operations/_operations.py | 12993 +++++++++++++++- .../clinicalmatching/_serialization.py | 89 +- .../healthinsights/clinicalmatching/_types.py | 12 + .../clinicalmatching/aio/_client.py | 30 +- .../clinicalmatching/aio/_configuration.py | 17 +- .../aio/_operations/_operations.py | 12964 ++++++++++++++- .../clinicalmatching/models/__init__.py | 104 +- .../clinicalmatching/models/_enums.py | 166 +- .../clinicalmatching/models/_models.py | 2945 +++- .../sample_match_trials_fhir_async.py | 25 +- ..._trials_structured_coded_elements_async.py | 98 +- .../samples/sample_match_trials_fhir.py | 19 +- ..._match_trials_structured_coded_elements.py | 51 +- .../setup.py | 13 +- .../tests/conftest.py | 4 +- .../tests/test_match_trials.py | 56 +- .../tsp-location.yaml | 7 + .../CHANGELOG.md | 5 + .../LICENSE | 21 + .../MANIFEST.in | 7 + .../README.md | 45 + .../_meta.json | 6 + .../azure/__init__.py | 1 + .../azure/healthinsights/__init__.py | 1 + .../patienttimeline/__init__.py | 26 + .../healthinsights/patienttimeline/_client.py | 98 + .../patienttimeline/_configuration.py | 62 + .../patienttimeline/_model_base.py | 828 + .../patienttimeline/_operations/__init__.py | 19 + .../_operations/_operations.py | 3053 ++++ .../patienttimeline/_operations/_patch.py | 20 + .../healthinsights/patienttimeline/_patch.py | 20 + .../patienttimeline/_serialization.py | 2005 +++ .../healthinsights/patienttimeline/_types.py | 12 + .../healthinsights/patienttimeline/_vendor.py | 26 + .../patienttimeline/_version.py | 9 + .../patienttimeline/aio/__init__.py | 23 + .../patienttimeline/aio/_client.py | 100 + .../patienttimeline/aio/_configuration.py | 62 + .../aio/_operations/__init__.py | 19 + .../aio/_operations/_operations.py | 3019 ++++ .../patienttimeline/aio/_operations/_patch.py | 20 + .../patienttimeline/aio/_patch.py | 20 + .../patienttimeline/aio/_vendor.py | 26 + .../patienttimeline/models/__init__.py | 127 + .../patienttimeline/models/_enums.py | 210 + .../patienttimeline/models/_models.py | 2541 +++ .../patienttimeline/models/_patch.py | 20 + .../healthinsights/patienttimeline/py.typed | 1 + .../dev_requirements.txt | 4 + .../sdk_packaging.toml | 2 + .../setup.py | 70 + .../tsp-location.yaml | 7 + .../CHANGELOG.md | 5 + .../LICENSE | 21 + .../MANIFEST.in | 7 + .../README.md | 45 + .../_meta.json | 6 + .../azure/__init__.py | 1 + .../azure/healthinsights/__init__.py | 1 + .../radiologyinsights/__init__.py | 26 + .../radiologyinsights/_client.py | 100 + .../radiologyinsights/_configuration.py | 62 + .../radiologyinsights/_model_base.py | 828 + .../radiologyinsights/_operations/__init__.py | 19 + .../_operations/_operations.py | 2255 +++ .../radiologyinsights/_operations/_patch.py | 20 + .../radiologyinsights/_patch.py | 20 + .../radiologyinsights/_serialization.py | 2005 +++ .../radiologyinsights/_types.py | 12 + .../radiologyinsights/_vendor.py | 26 + .../radiologyinsights/_version.py | 9 + .../radiologyinsights/aio/__init__.py | 23 + .../radiologyinsights/aio/_client.py | 102 + .../radiologyinsights/aio/_configuration.py | 62 + .../aio/_operations/__init__.py | 19 + .../aio/_operations/_operations.py | 2221 +++ .../aio/_operations/_patch.py | 20 + .../radiologyinsights/aio/_patch.py | 20 + .../radiologyinsights/aio/_vendor.py | 26 + .../radiologyinsights/models/__init__.py | 173 + .../radiologyinsights/models/_enums.py | 265 + .../radiologyinsights/models/_models.py | 3523 +++++ .../radiologyinsights/models/_patch.py | 20 + .../healthinsights/radiologyinsights/py.typed | 1 + .../dev_requirements.txt | 4 + .../sdk_packaging.toml | 2 + .../setup.py | 70 + .../tsp-location.yaml | 7 + sdk/healthinsights/ci.yml | 4 + 113 files changed, 59590 insertions(+), 2261 deletions(-) create mode 100644 sdk/healthinsights/azure-healthinsights-cancerprofiling/_meta.json create mode 100644 sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_types.py create mode 100644 sdk/healthinsights/azure-healthinsights-cancerprofiling/tsp-location.yaml create mode 100644 sdk/healthinsights/azure-healthinsights-clinicalmatching/_meta.json create mode 100644 sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_types.py create mode 100644 sdk/healthinsights/azure-healthinsights-clinicalmatching/tsp-location.yaml create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/CHANGELOG.md create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/LICENSE create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/MANIFEST.in create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/README.md create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/_meta.json create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_client.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_configuration.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_model_base.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_operations.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_patch.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_patch.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_serialization.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_types.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_vendor.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_version.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_client.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_configuration.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_operations.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_patch.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_patch.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_vendor.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_enums.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_models.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_patch.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/py.typed create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/dev_requirements.txt create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/sdk_packaging.toml create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/setup.py create mode 100644 sdk/healthinsights/azure-healthinsights-patienttimeline/tsp-location.yaml create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/CHANGELOG.md create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/LICENSE create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/MANIFEST.in create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/README.md create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/_meta.json create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_client.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_configuration.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_model_base.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_operations.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_patch.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_patch.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_serialization.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_types.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_vendor.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_version.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_client.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_configuration.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_operations.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_patch.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_patch.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_vendor.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/__init__.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_enums.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_models.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_patch.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/py.typed create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/dev_requirements.txt create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/sdk_packaging.toml create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/setup.py create mode 100644 sdk/healthinsights/azure-healthinsights-radiologyinsights/tsp-location.yaml diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/_meta.json b/sdk/healthinsights/azure-healthinsights-cancerprofiling/_meta.json new file mode 100644 index 0000000000000..c3dc8e738f059 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "f3dcae0fb8ccf9267fa0c8eb32f52125c58cd0fd", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/ai/HealthInsights/HealthInsights.OncoPhenotype", + "@azure-tools/typespec-python": "0.18.3" +} \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_client.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_client.py index 4ac3aa0699a5d..557fd9f0442ee 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_client.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_client.py @@ -11,6 +11,7 @@ from azure.core import PipelineClient from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies from azure.core.rest import HttpRequest, HttpResponse from ._configuration import CancerProfilingClientConfiguration @@ -18,9 +19,7 @@ from ._serialization import Deserializer, Serializer -class CancerProfilingClient( - CancerProfilingClientOperationsMixin -): # pylint: disable=client-accepts-api-version-keyword +class CancerProfilingClient(CancerProfilingClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword """CancerProfilingClient. :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: @@ -29,7 +28,7 @@ class CancerProfilingClient( :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str :keyword int polling_interval: Default waiting time between two polls for LRO operations if no @@ -37,15 +36,32 @@ class CancerProfilingClient( """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - _endpoint = "{endpoint}/healthinsights" + _endpoint = "{endpoint}/health-insights" self._config = CancerProfilingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - self._client: PipelineClient = PipelineClient(base_url=_endpoint, config=self._config, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) self._serialize = Serializer() self._deserialize = Deserializer() self._serialize.client_side_validation = False - def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -69,7 +85,7 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore def close(self) -> None: self._client.close() diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_configuration.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_configuration.py index 81364c5be4f27..c69488a35ec77 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_configuration.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_configuration.py @@ -6,22 +6,15 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import sys from typing import Any -from azure.core.configuration import Configuration from azure.core.credentials import AzureKeyCredential from azure.core.pipeline import policies from ._version import VERSION -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - -class CancerProfilingClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes +class CancerProfilingClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long """Configuration for CancerProfilingClient. Note that all parameters used to create this instance are saved as instance @@ -33,14 +26,13 @@ class CancerProfilingClientConfiguration(Configuration): # pylint: disable=too- :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - super(CancerProfilingClientConfiguration, self).__init__(**kwargs) - api_version: Literal["2023-03-01-preview"] = kwargs.pop("api_version", "2023-03-01-preview") + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -51,6 +43,7 @@ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) self.credential = credential self.api_version = api_version kwargs.setdefault("sdk_moniker", "healthinsights-cancerprofiling/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _configure(self, **kwargs: Any) -> None: @@ -59,9 +52,9 @@ def _configure(self, **kwargs: Any) -> None: self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) - self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) self.authentication_policy = kwargs.get("authentication_policy") if self.credential and not self.authentication_policy: self.authentication_policy = policies.AzureKeyCredentialPolicy( diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_model_base.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_model_base.py index c6fcd9a18c252..585ccb0e0f90a 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_model_base.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_model_base.py @@ -7,6 +7,8 @@ # pylint: disable=protected-access, arguments-differ, signature-differs, broad-except # pyright: reportGeneralTypeIssues=false +import calendar +import decimal import functools import sys import logging @@ -14,13 +16,14 @@ import re import copy import typing +import email from datetime import datetime, date, time, timedelta, timezone from json import JSONEncoder import isodate from azure.core.exceptions import DeserializationError from azure.core import CaseInsensitiveEnumMeta from azure.core.pipeline import PipelineResponse -from azure.core.serialization import NULL as AzureCoreNull +from azure.core.serialization import _Null if sys.version_info >= (3, 9): from collections.abc import MutableMapping @@ -29,23 +32,7 @@ _LOGGER = logging.getLogger(__name__) -__all__ = ["NULL", "AzureJSONEncoder", "Model", "rest_field", "rest_discriminator"] - - -class _Null(object): - """To create a Falsy object""" - - def __bool__(self): - return False - - __nonzero__ = __bool__ # Python2 compatibility - - -NULL = _Null() -""" -A falsy sentinel object which is supposed to be used to specify attributes -with no data. This gets serialized to `null` on the wire. -""" +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] TZ_UTC = timezone.utc @@ -74,69 +61,53 @@ def _timedelta_as_isostr(td: timedelta) -> str: if days: date_str = "%sD" % days - # Build time - time_str = "T" + if hours or minutes or seconds: + # Build time + time_str = "T" - # Hours - bigger_exists = date_str or hours - if bigger_exists: - time_str += "{:02}H".format(hours) + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) - # Minutes - bigger_exists = bigger_exists or minutes - if bigger_exists: - time_str += "{:02}M".format(minutes) + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) - # Seconds - try: - if seconds.is_integer(): - seconds_string = "{:02}".format(int(seconds)) - else: - # 9 chars long w/ leading 0, 6 digits after decimal - seconds_string = "%09.6f" % seconds - # Remove trailing zeros - seconds_string = seconds_string.rstrip("0") - except AttributeError: # int.is_integer() raises - seconds_string = "{:02}".format(seconds) + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) - time_str += "{}S".format(seconds_string) + time_str += "{}S".format(seconds_string) + else: + time_str = "" return "P" + date_str + time_str -def _datetime_as_isostr(dt: typing.Union[datetime, date, time, timedelta]) -> str: - """Converts a datetime.(datetime|date|time|timedelta) object into an ISO 8601 formatted string - - :param timedelta dt: The date object to convert - :rtype: str - :return: ISO8601 version of this datetime - """ - # First try datetime.datetime - if hasattr(dt, "year") and hasattr(dt, "hour"): - dt = typing.cast(datetime, dt) - # astimezone() fails for naive times in Python 2.7, so make make sure dt is aware (tzinfo is set) - if not dt.tzinfo: - iso_formatted = dt.replace(tzinfo=TZ_UTC).isoformat() - else: - iso_formatted = dt.astimezone(TZ_UTC).isoformat() - # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) - return iso_formatted.replace("+00:00", "Z") - # Next try datetime.date or datetime.time - try: - dt = typing.cast(typing.Union[date, time], dt) - return dt.isoformat() - # Last, try datetime.timedelta - except AttributeError: - dt = typing.cast(timedelta, dt) - return _timedelta_as_isostr(dt) - - -def _serialize_bytes(o) -> str: - return base64.b64encode(o).decode() +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded -def _serialize_datetime(o): +def _serialize_datetime(o, format: typing.Optional[str] = None): if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) if not o.tzinfo: iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() @@ -150,32 +121,37 @@ def _serialize_datetime(o): def _is_readonly(p): try: - return p._readonly # pylint: disable=protected-access + return p._visibility == ["read"] # pylint: disable=protected-access except AttributeError: return False -class AzureJSONEncoder(JSONEncoder): +class SdkJSONEncoder(JSONEncoder): """A JSON encoder that's capable of serializing datetime objects and bytes.""" + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + def default(self, o): # pylint: disable=too-many-return-statements if _is_model(o): - readonly_props = [ - p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p) - ] # pylint: disable=protected-access - return {k: v for k, v in o.items() if k not in readonly_props} - if isinstance(o, (bytes, bytearray)): - return base64.b64encode(o).decode() - if o is AzureCoreNull: - return None + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) try: - return super(AzureJSONEncoder, self).default(o) + return super(SdkJSONEncoder, self).default(o) except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) if isinstance(o, (bytes, bytearray)): - return _serialize_bytes(o) + return _serialize_bytes(o, self.format) try: # First try datetime.datetime - return _serialize_datetime(o) + return _serialize_datetime(o, self.format) except AttributeError: pass # Last, try datetime.timedelta @@ -184,10 +160,14 @@ def default(self, o): # pylint: disable=too-many-return-statements except AttributeError: # This will be raised when it hits value.total_seconds in the method above pass - return super(AzureJSONEncoder, self).default(o) + return super(SdkJSONEncoder, self).default(o) _VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: @@ -223,6 +203,36 @@ def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: return date_obj +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + def _deserialize_date(attr: typing.Union[str, date]) -> date: """Deserialize ISO-8601 formatted string into Date object. :param str attr: response string to be deserialized. @@ -247,33 +257,74 @@ def _deserialize_time(attr: typing.Union[str, time]) -> time: return isodate.parse_time(attr) -def deserialize_bytes(attr): +def _deserialize_bytes(attr): if isinstance(attr, (bytes, bytearray)): return attr return bytes(base64.b64decode(attr)) -def deserialize_duration(attr): +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): if isinstance(attr, timedelta): return attr return isodate.parse_duration(attr) +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + _DESERIALIZE_MAPPING = { datetime: _deserialize_datetime, date: _deserialize_date, time: _deserialize_time, - bytes: deserialize_bytes, - timedelta: deserialize_duration, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, } +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + def _get_model(module_name: str, model_name: str): models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} module_end = module_name.rsplit(".", 1)[0] - module = sys.modules[module_end] - models.update({k: v for k, v in module.__dict__.items() if isinstance(v, type)}) + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) if isinstance(model_name, str): model_name = model_name.split(".")[-1] if model_name not in models: @@ -374,12 +425,22 @@ def _is_model(obj: typing.Any) -> bool: return getattr(obj, "_is_model", False) -def _serialize(o): +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) if isinstance(o, (bytes, bytearray)): - return _serialize_bytes(o) + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) try: # First try datetime.datetime - return _serialize_datetime(o) + return _serialize_datetime(o, format) except AttributeError: pass # Last, try datetime.timedelta @@ -401,7 +462,7 @@ def _get_rest_field( def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: - return _deserialize(rf._type, value) if (rf and rf._is_model) else _serialize(value) + return _deserialize(rf._type, value) if (rf and rf._is_model) else _serialize(value, rf._format if rf else None) class Model(_MyMutableMapping): @@ -425,7 +486,13 @@ def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: if non_attr_kwargs: # actual type errors only throw the first wrong keyword arg they see, so following that. raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") - dict_to_pass.update({self._attr_to_rest_field[k]._rest_name: _serialize(v) for k, v in kwargs.items()}) + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) super().__init__(dict_to_pass) def copy(self) -> "Model": @@ -459,31 +526,77 @@ def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member @classmethod - def _get_discriminator(cls) -> typing.Optional[str]: + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: for v in cls.__dict__.values(): - if isinstance(v, _RestField) and v._is_discriminator: # pylint: disable=protected-access + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access return v._rest_name # pylint: disable=protected-access return None @classmethod - def _deserialize(cls, data): + def _deserialize(cls, data, exist_discriminators): if not hasattr(cls, "__mapping__"): # pylint: disable=no-member return cls(data) - discriminator = cls._get_discriminator() + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pylint: disable=no-member if mapped_cls == cls: return cls(data) - return mapped_cls._deserialize(data) # pylint: disable=protected-access + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore[reportUnboundVariable] + continue + result[k] = Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return [Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v] + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v -def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-return-statements, too-many-statements - annotation: typing.Any, module: typing.Optional[str], rf: typing.Optional["_RestField"] = None +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: if not annotation or annotation in [int, float]: return None + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + try: - if module and _is_model(_get_model(module, annotation)): + if module and _is_model(annotation): if rf: rf._is_model = True @@ -492,40 +605,20 @@ def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj return obj return _deserialize(model_deserializer, obj) - return functools.partial(_deserialize_model, _get_model(module, annotation)) + return functools.partial(_deserialize_model, annotation) except Exception: pass # is it a literal? try: - if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports - else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - - if annotation.__origin__ == Literal: + if annotation.__origin__ is typing.Literal: return None except AttributeError: pass - if getattr(annotation, "__origin__", None) is typing.Union: - - def _deserialize_with_union(union_annotation, obj): - for t in union_annotation.__args__: - try: - return _deserialize(t, obj, module) - except DeserializationError: - pass - raise DeserializationError() - - return functools.partial(_deserialize_with_union, annotation) - # is it optional? try: - # right now, assuming we don't have unions, since we're getting rid of the only - # union we used to have in msrest models, which was union of str and enum if any(a for a in annotation.__args__ if a == type(None)): - if_obj_deserializer = _get_deserialize_callable_from_annotation( next(a for a in annotation.__args__ if a != type(None)), module, rf ) @@ -539,35 +632,33 @@ def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Calla except AttributeError: pass - # is it a forward ref / in quotes? - if isinstance(annotation, (str, typing.ForwardRef)): - try: - model_name = annotation.__forward_arg__ # type: ignore - except AttributeError: - model_name = annotation - if module is not None: - annotation = _get_model(module, model_name) + if getattr(annotation, "__origin__", None) is typing.Union: + deserializers = [_get_deserialize_callable_from_annotation(arg, module, rf) for arg in annotation.__args__] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) try: if annotation._name == "Dict": - key_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) value_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[1], module, rf) def _deserialize_dict( - key_deserializer: typing.Optional[typing.Callable], value_deserializer: typing.Optional[typing.Callable], obj: typing.Dict[typing.Any, typing.Any], ): if obj is None: return obj - return { - _deserialize(key_deserializer, k, module): _deserialize(value_deserializer, v, module) - for k, v in obj.items() - } + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} return functools.partial( _deserialize_dict, - key_deserializer, value_deserializer, ) except (AttributeError, IndexError): @@ -577,7 +668,8 @@ def _deserialize_dict( if len(annotation.__args__) > 1: def _deserialize_multiple_sequence( - entry_deserializers: typing.List[typing.Optional[typing.Callable]], obj + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, ): if obj is None: return obj @@ -605,26 +697,29 @@ def _deserialize_sequence( pass def _deserialize_default( - annotation, - deserializer_from_mapping, + deserializer, obj, ): if obj is None: return obj try: - return _deserialize_with_callable(annotation, obj) + return _deserialize_with_callable(deserializer, obj) except Exception: pass - return _deserialize_with_callable(deserializer_from_mapping, obj) + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) - return functools.partial(_deserialize_default, annotation, _DESERIALIZE_MAPPING.get(annotation)) + return functools.partial(_deserialize_default, annotation) def _deserialize_with_callable( - deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], value: typing.Any + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, ): try: - if value is None: + if value is None or isinstance(value, _Null): return None if deserializer is None: return value @@ -635,16 +730,25 @@ def _deserialize_with_callable( # for unknown value, return raw value return value if isinstance(deserializer, type) and issubclass(deserializer, Model): - return deserializer._deserialize(value) # type: ignore + return deserializer._deserialize(value, []) return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) except Exception as e: raise DeserializationError() from e -def _deserialize(deserializer: typing.Any, value: typing.Any, module: typing.Optional[str] = None) -> typing.Any: +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: if isinstance(value, PipelineResponse): value = value.http_response.json() - deserializer = _get_deserialize_callable_from_annotation(deserializer, module) + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) return _deserialize_with_callable(deserializer, value) @@ -655,16 +759,18 @@ def __init__( name: typing.Optional[str] = None, type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin is_discriminator: bool = False, - readonly: bool = False, + visibility: typing.Optional[typing.List[str]] = None, default: typing.Any = _UNSET, + format: typing.Optional[str] = None, ): self._type = type self._rest_name_input = name self._module: typing.Optional[str] = None self._is_discriminator = is_discriminator - self._readonly = readonly + self._visibility = visibility self._is_model = False self._default = default + self._format = format @property def _rest_name(self) -> str: @@ -678,7 +784,9 @@ def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin item = obj.get(self._rest_name) if item is None: return item - return _deserialize(self._type, _serialize(item)) + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) def __set__(self, obj: Model, value) -> None: if value is None: @@ -688,11 +796,14 @@ def __set__(self, obj: Model, value) -> None: except KeyError: pass return - if self._is_model and not _is_model(value): - obj.__setitem__(self._rest_name, _deserialize(self._type, value)) - obj.__setitem__(self._rest_name, _serialize(value)) + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) - def _get_deserialize_callable_from_annotation( # pylint: disable=redefined-builtin + def _get_deserialize_callable_from_annotation( self, annotation: typing.Any ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: return _get_deserialize_callable_from_annotation(annotation, self._module, self) @@ -702,13 +813,16 @@ def rest_field( *, name: typing.Optional[str] = None, type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin - readonly: bool = False, + visibility: typing.Optional[typing.List[str]] = None, default: typing.Any = _UNSET, + format: typing.Optional[str] = None, ) -> typing.Any: - return _RestField(name=name, type=type, readonly=readonly, default=default) + return _RestField(name=name, type=type, visibility=visibility, default=default, format=format) def rest_discriminator( - *, name: typing.Optional[str] = None, type: typing.Optional[typing.Callable] = None # pylint: disable=redefined-builtin + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin ) -> typing.Any: return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_operations/_operations.py index 7074943fed201..8edf0bc661251 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_operations/_operations.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_operations/_operations.py @@ -1,4 +1,4 @@ -# pylint: disable=too-many-lines +# pylint: disable=too-many-lines,too-many-statements # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -7,9 +7,11 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- import datetime +from io import IOBase import json import sys from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload +import uuid from azure.core.exceptions import ( ClientAuthenticationError, @@ -20,15 +22,14 @@ map_error, ) from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import HttpResponse from azure.core.polling import LROPoller, NoPolling, PollingMethod from azure.core.polling.base_polling import LROBasePolling -from azure.core.rest import HttpRequest +from azure.core.rest import HttpRequest, HttpResponse from azure.core.tracing.decorator import distributed_trace from azure.core.utils import case_insensitive_dict from .. import models as _models -from .._model_base import AzureJSONEncoder, _deserialize +from .._model_base import SdkJSONEncoder, _deserialize from .._serialization import Serializer from .._vendor import CancerProfilingClientMixinABC @@ -36,10 +37,6 @@ from collections.abc import MutableMapping else: from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] @@ -48,35 +45,26 @@ _SERIALIZER.client_side_validation = False -def build_cancer_profiling_infer_cancer_profile_request( # pylint: disable=name-too-long - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any -) -> HttpRequest: +def build_cancer_profiling_infer_cancer_profile_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: Literal["2023-03-01-preview"] = kwargs.pop( - "api_version", _params.pop("api-version", "2023-03-01-preview") - ) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL - _url = "/oncophenotype/jobs" + _url = "/onco-phenotype/jobs" # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers - if repeatability_request_id is not None: - _headers["Repeatability-Request-ID"] = _SERIALIZER.header( - "repeatability_request_id", repeatability_request_id, "str" - ) - if repeatability_first_sent is not None: - _headers["Repeatability-First-Sent"] = _SERIALIZER.header( - "repeatability_first_sent", repeatability_first_sent, "iso-8601" + if "Repeatability-Request-ID" not in _headers: + _headers["Repeatability-Request-ID"] = str(uuid.uuid4()) + if "Repeatability-First-Sent" not in _headers: + _headers["Repeatability-First-Sent"] = _SERIALIZER.serialize_data( + datetime.datetime.now(datetime.timezone.utc), "rfc-1123" ) _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") if content_type is not None: @@ -87,13 +75,8 @@ def build_cancer_profiling_infer_cancer_profile_request( # pylint: disable=name class CancerProfilingClientOperationsMixin(CancerProfilingClientMixinABC): def _infer_cancer_profile_initial( - self, - body: Union[_models.OncoPhenotypeData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> Optional[_models.OncoPhenotypeResult]: + self, body: Union[_models.OncoPhenotypeData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: error_map = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, @@ -106,18 +89,16 @@ def _infer_cancer_profile_initial( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[Optional[_models.OncoPhenotypeResult]] = kwargs.pop("cls", None) + cls: ClsType[JSON] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None - if isinstance(body, (IO, bytes)): + if isinstance(body, (IOBase, bytes)): _content = body else: - _content = json.dumps(body, cls=AzureJSONEncoder) # type: ignore + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_cancer_profiling_infer_cancer_profile_request( - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, + _request = build_cancer_profiling_infer_cancer_profile_request( content_type=content_type, api_version=self._config.api_version, content=_content, @@ -127,218 +108,2280 @@ def _infer_cancer_profile_initial( path_format_arguments = { "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [200, 202]: + if response.status_code not in [202]: + if _stream: + response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) - deserialized = None response_headers = {} - if response.status_code == 200: - deserialized = _deserialize(_models.OncoPhenotypeResult, response.json()) + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) - if response.status_code == 202: - response_headers["Operation-Location"] = self._deserialize( - "str", response.headers.get("Operation-Location") - ) - response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) - response_headers["Repeatability-Result"] = self._deserialize( - "str", response.headers.get("Repeatability-Result") - ) + deserialized = _deserialize(JSON, response.json()) if cls: - return cls(pipeline_response, deserialized, response_headers) + return cls(pipeline_response, deserialized, response_headers) # type: ignore - return deserialized + return deserialized # type: ignore @overload def begin_infer_cancer_profile( - self, - body: _models.OncoPhenotypeData, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> LROPoller[_models.OncoPhenotypeResult]: + self, body: _models.OncoPhenotypeData, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. :param body: Required. :type body: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeData - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns OncoPhenotypeResult. The OncoPhenotypeResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "checkForCancerCase": bool, # Optional. An indication whether to + perform a preliminary step on the patient's documents to determine whether + they relate to a Cancer case. + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceTypes": [ + "str" # Optional. A list of inference types to be inferred + for the current request. This could be used if only part of the Onco + Phenotype inferences are required. If this list is omitted or empty, the + model will return all the inference types. + ], + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ @overload def begin_infer_cancer_profile( - self, - body: JSON, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> LROPoller[_models.OncoPhenotypeResult]: + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. :param body: Required. :type body: JSON - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns OncoPhenotypeResult. The OncoPhenotypeResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ @overload def begin_infer_cancer_profile( - self, - body: IO, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> LROPoller[_models.OncoPhenotypeResult]: + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. :param body: Required. - :type body: IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime + :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns OncoPhenotypeResult. The OncoPhenotypeResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ @distributed_trace def begin_infer_cancer_profile( - self, - body: Union[_models.OncoPhenotypeData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> LROPoller[_models.OncoPhenotypeResult]: + self, body: Union[_models.OncoPhenotypeData, JSON, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. - :param body: Is one of the following types: OncoPhenotypeData, JSON, IO Required. - :type body: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeData or JSON or IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime + :param body: Is one of the following types: OncoPhenotypeData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeData or JSON or IO[bytes] :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default value is None. :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns OncoPhenotypeResult. The OncoPhenotypeResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "checkForCancerCase": bool, # Optional. An indication whether to + perform a preliminary step on the patient's documents to determine whether + they relate to a Cancer case. + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceTypes": [ + "str" # Optional. A list of inference types to be inferred + for the current request. This could be used if only part of the Onco + Phenotype inferences are required. If this list is omitted or empty, the + model will return all the inference types. + ], + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[_models.OncoPhenotypeResult] = kwargs.pop("cls", None) + cls: ClsType[_models.OncoPhenotypeInferenceResult] = kwargs.pop("cls", None) polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token: Optional[str] = kwargs.pop("continuation_token", None) if cont_token is None: raw_result = self._infer_cancer_profile_initial( - body=body, - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, - content_type=content_type, - cls=lambda x, y, z: x, - headers=_headers, - params=_params, - **kwargs + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs ) kwargs.pop("error_map", None) def get_long_running_output(pipeline_response): + response_headers = {} response = pipeline_response.http_response - deserialized = _deserialize(_models.OncoPhenotypeResult, response.json()) + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.OncoPhenotypeInferenceResult, response.json().get("result")) if cls: - return cls(pipeline_response, deserialized, {}) # type: ignore + return cls(pipeline_response, deserialized, response_headers) # type: ignore return deserialized path_format_arguments = { @@ -354,10 +2397,12 @@ def get_long_running_output(pipeline_response): else: polling_method = polling if cont_token: - return LROPoller.from_continuation_token( + return LROPoller[_models.OncoPhenotypeInferenceResult].from_continuation_token( polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output, ) - return LROPoller(self._client, raw_result, get_long_running_output, polling_method) # type: ignore + return LROPoller[_models.OncoPhenotypeInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_serialization.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_serialization.py index f17c068e833e8..baa661cb82d24 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_serialization.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_serialization.py @@ -63,8 +63,8 @@ import isodate # type: ignore -from azure.core.exceptions import DeserializationError, SerializationError, raise_with_traceback -from azure.core.serialization import NULL as AzureCoreNull +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull _BOM = codecs.BOM_UTF8.decode(encoding="utf-8") @@ -124,7 +124,7 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: pass return ET.fromstring(data_as_str) # nosec - except ET.ParseError: + except ET.ParseError as err: # It might be because the server has an issue, and returned JSON with # content-type XML.... # So let's try a JSON load, and if it's still broken @@ -143,7 +143,7 @@ def _json_attemp(data): # The function hack is because Py2.7 messes up with exception # context otherwise. _LOGGER.critical("Wasn't XML not JSON, failing") - raise_with_traceback(DeserializationError, "XML is invalid") + raise DeserializationError("XML is invalid") from err raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) @classmethod @@ -295,7 +295,7 @@ class Model(object): _validation: Dict[str, Dict[str, Any]] = {} def __init__(self, **kwargs: Any) -> None: - self.additional_properties: Dict[str, Any] = {} + self.additional_properties: Optional[Dict[str, Any]] = {} for k in kwargs: if k not in self._attribute_map: _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) @@ -340,7 +340,7 @@ def _create_xml_node(cls): return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: - """Return the JSON that would be sent to azure from this model. + """Return the JSON that would be sent to server from this model. This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. @@ -351,7 +351,7 @@ def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore def as_dict( self, @@ -390,7 +390,7 @@ def my_key_transformer(key, attr_desc, value): :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore @classmethod def _infer_class_models(cls): @@ -415,7 +415,7 @@ def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = N :raises: DeserializationError if something went wrong """ deserializer = Deserializer(cls._infer_class_models()) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def from_dict( @@ -445,7 +445,7 @@ def from_dict( if key_extractors is None else key_extractors ) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def _flatten_subtype(cls, key, objects): @@ -629,7 +629,7 @@ def _serialize(self, target_obj, data_type=None, **kwargs): if xml_desc.get("attr", False): if xml_ns: ET.register_namespace(xml_prefix, xml_ns) - xml_name = "{}{}".format(xml_ns, xml_name) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) serialized.set(xml_name, new_attr) # type: ignore continue if xml_desc.get("text", False): @@ -662,12 +662,13 @@ def _serialize(self, target_obj, data_type=None, **kwargs): _serialized.update(_new_attr) # type: ignore _new_attr = _new_attr[k] # type: ignore _serialized = _serialized[k] - except ValueError: - continue + except ValueError as err: + if isinstance(err, SerializationError): + raise except (AttributeError, KeyError, TypeError) as err: msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) - raise_with_traceback(SerializationError, msg, err) + raise SerializationError(msg) from err else: return serialized @@ -709,7 +710,7 @@ def body(self, data, data_type, **kwargs): ] data = deserializer._deserialize(data_type, data) except DeserializationError as err: - raise_with_traceback(SerializationError, "Unable to build a model: " + str(err), err) + raise SerializationError("Unable to build a model: " + str(err)) from err return self._serialize(data, data_type, **kwargs) @@ -729,6 +730,7 @@ def url(self, name, data, data_type, **kwargs): if kwargs.get("skip_quote") is True: output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) else: output = quote(str(output), safe="") except SerializationError: @@ -741,7 +743,9 @@ def query(self, name, data, data_type, **kwargs): :param data: The data to be serialized. :param str data_type: The type to be serialized from. - :rtype: str + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list :raises: TypeError if serialization fails. :raises: ValueError if data is None """ @@ -749,10 +753,8 @@ def query(self, name, data, data_type, **kwargs): # Treat the list aside, since we don't want to encode the div separator if data_type.startswith("["): internal_data_type = data_type[1:-1] - data = [self.serialize_data(d, internal_data_type, **kwargs) if d is not None else "" for d in data] - if not kwargs.get("skip_quote", False): - data = [quote(str(d), safe="") for d in data] - return str(self.serialize_iter(data, internal_data_type, **kwargs)) + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) # Not a list, regular serialization output = self.serialize_data(data, data_type, **kwargs) @@ -803,7 +805,7 @@ def serialize_data(self, data, data_type, **kwargs): raise ValueError("No value for given attribute") try: - if data is AzureCoreNull: + if data is CoreNull: return None if data_type in self.basic_types.values(): return self.serialize_basic(data, data_type, **kwargs) @@ -823,7 +825,7 @@ def serialize_data(self, data, data_type, **kwargs): except (ValueError, TypeError) as err: msg = "Unable to serialize value: {!r} as type: {!r}." - raise_with_traceback(SerializationError, msg.format(data, data_type), err) + raise SerializationError(msg.format(data, data_type)) from err else: return self._serialize(data, **kwargs) @@ -891,6 +893,8 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): not be None or empty. :param str div: If set, this str will be used to combine the elements in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. :rtype: list, str """ if isinstance(data, str): @@ -903,9 +907,14 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): for d in data: try: serialized.append(self.serialize_data(d, iter_type, **kwargs)) - except ValueError: + except ValueError as err: + if isinstance(err, SerializationError): + raise serialized.append(None) + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + if div: serialized = ["" if s is None else str(s) for s in serialized] serialized = div.join(serialized) @@ -950,7 +959,9 @@ def serialize_dict(self, attr, dict_type, **kwargs): for key, value in attr.items(): try: serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) - except ValueError: + except ValueError as err: + if isinstance(err, SerializationError): + raise serialized[self.serialize_unicode(key)] = None if "xml" in serialization_ctxt: @@ -1160,10 +1171,10 @@ def serialize_iso(attr, **kwargs): return date + microseconds + "Z" except (ValueError, OverflowError) as err: msg = "Unable to serialize datetime object." - raise_with_traceback(SerializationError, msg, err) + raise SerializationError(msg) from err except AttributeError as err: msg = "ISO-8601 object must be valid Datetime object." - raise_with_traceback(TypeError, msg, err) + raise TypeError(msg) from err @staticmethod def serialize_unix(attr, **kwargs): @@ -1199,7 +1210,6 @@ def rest_key_extractor(attr, attr_desc, data): if working_data is None: # If at any point while following flatten JSON path see None, it means # that all properties under are None as well - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) @@ -1220,7 +1230,6 @@ def rest_key_case_insensitive_extractor(attr, attr_desc, data): if working_data is None: # If at any point while following flatten JSON path see None, it means # that all properties under are None as well - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) @@ -1271,7 +1280,7 @@ def _extract_name_from_internal_type(internal_type): xml_name = internal_type_xml_map.get("name", internal_type.__name__) xml_ns = internal_type_xml_map.get("ns", None) if xml_ns: - xml_name = "{}{}".format(xml_ns, xml_name) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) return xml_name @@ -1295,7 +1304,7 @@ def xml_key_extractor(attr, attr_desc, data): # Integrate namespace if necessary xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) if xml_ns: - xml_name = "{}{}".format(xml_ns, xml_name) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) # If it's an attribute, that's simple if xml_desc.get("attr", False): @@ -1471,7 +1480,7 @@ def _deserialize(self, target_obj, data): d_attrs[attr] = value except (AttributeError, TypeError, KeyError) as err: msg = "Unable to deserialize to object: " + class_name # type: ignore - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: additional_properties = self._build_additional_properties(attributes, data) return self._instantiate_model(response, d_attrs, additional_properties) @@ -1642,7 +1651,7 @@ def deserialize_data(self, data, data_type): except (ValueError, TypeError, AttributeError) as err: msg = "Unable to deserialize response data." msg += " Data: {}, {}".format(data, data_type) - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return self._deserialize(obj_type, data) @@ -1798,7 +1807,6 @@ def deserialize_enum(data, enum_obj): data = data.value if isinstance(data, int): # Workaround. We might consider remove it in the future. - # https://github.com/Azure/azure-rest-api-specs/issues/141 try: return list(enum_obj.__members__.values())[data] except IndexError: @@ -1852,10 +1860,10 @@ def deserialize_decimal(attr): if isinstance(attr, ET.Element): attr = attr.text try: - return decimal.Decimal(attr) # type: ignore + return decimal.Decimal(str(attr)) # type: ignore except decimal.DecimalException as err: msg = "Invalid decimal {}".format(attr) - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err @staticmethod def deserialize_long(attr): @@ -1883,7 +1891,7 @@ def deserialize_duration(attr): duration = isodate.parse_duration(attr) except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize duration object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return duration @@ -1900,7 +1908,7 @@ def deserialize_date(attr): if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore raise DeserializationError("Date must have only digits and -. Received: %s" % attr) # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. - return isodate.parse_date(attr, defaultmonth=None, defaultday=None) + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) @staticmethod def deserialize_time(attr): @@ -1935,7 +1943,7 @@ def deserialize_rfc(attr): date_obj = date_obj.astimezone(tz=TZ_UTC) except ValueError as err: msg = "Cannot deserialize to rfc datetime object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return date_obj @@ -1972,7 +1980,7 @@ def deserialize_iso(attr): raise OverflowError("Hit max or min date") except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize datetime object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return date_obj @@ -1988,9 +1996,10 @@ def deserialize_unix(attr): if isinstance(attr, ET.Element): attr = int(attr.text) # type: ignore try: + attr = int(attr) date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) except ValueError as err: msg = "Cannot deserialize to unix datetime object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return date_obj diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_types.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_types.py new file mode 100644 index 0000000000000..52104a479bf79 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_types.py @@ -0,0 +1,12 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Literal, Union + +RepeatabilityResult = Union[Literal["accepted"], Literal["rejected"]] diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_client.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_client.py index f1c88e35b696a..499a09b530f74 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_client.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_client.py @@ -11,6 +11,7 @@ from azure.core import AsyncPipelineClient from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies from azure.core.rest import AsyncHttpResponse, HttpRequest from .._serialization import Deserializer, Serializer @@ -27,7 +28,7 @@ class CancerProfilingClient(CancerProfilingClientOperationsMixin): # pylint: di :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str :keyword int polling_interval: Default waiting time between two polls for LRO operations if no @@ -35,15 +36,34 @@ class CancerProfilingClient(CancerProfilingClientOperationsMixin): # pylint: di """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - _endpoint = "{endpoint}/healthinsights" + _endpoint = "{endpoint}/health-insights" self._config = CancerProfilingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, config=self._config, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) self._serialize = Serializer() self._deserialize = Deserializer() self._serialize.client_side_validation = False - def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]: + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -67,7 +87,7 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHt } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore async def close(self) -> None: await self._client.close() diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_configuration.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_configuration.py index 9bbb5f047bd08..4400e512cc83e 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_configuration.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_configuration.py @@ -6,22 +6,15 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import sys from typing import Any -from azure.core.configuration import Configuration from azure.core.credentials import AzureKeyCredential from azure.core.pipeline import policies from .._version import VERSION -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - -class CancerProfilingClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes +class CancerProfilingClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long """Configuration for CancerProfilingClient. Note that all parameters used to create this instance are saved as instance @@ -33,14 +26,13 @@ class CancerProfilingClientConfiguration(Configuration): # pylint: disable=too- :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - super(CancerProfilingClientConfiguration, self).__init__(**kwargs) - api_version: Literal["2023-03-01-preview"] = kwargs.pop("api_version", "2023-03-01-preview") + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -51,6 +43,7 @@ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) self.credential = credential self.api_version = api_version kwargs.setdefault("sdk_moniker", "healthinsights-cancerprofiling/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _configure(self, **kwargs: Any) -> None: @@ -59,9 +52,9 @@ def _configure(self, **kwargs: Any) -> None: self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) - self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) self.authentication_policy = kwargs.get("authentication_policy") if self.credential and not self.authentication_policy: self.authentication_policy = policies.AzureKeyCredentialPolicy( diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_operations/_operations.py index 7d03f6f8261a9..3c248ea39385d 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_operations/_operations.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_operations/_operations.py @@ -1,4 +1,4 @@ -# pylint: disable=too-many-lines +# pylint: disable=too-many-lines,too-many-statements # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -6,7 +6,7 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import datetime +from io import IOBase import json import sys from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload @@ -20,15 +20,14 @@ map_error, ) from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import AsyncHttpResponse from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod from azure.core.polling.async_base_polling import AsyncLROBasePolling -from azure.core.rest import HttpRequest +from azure.core.rest import AsyncHttpResponse, HttpRequest from azure.core.tracing.decorator_async import distributed_trace_async from azure.core.utils import case_insensitive_dict from ... import models as _models -from ..._model_base import AzureJSONEncoder, _deserialize +from ..._model_base import SdkJSONEncoder, _deserialize from ..._operations._operations import build_cancer_profiling_infer_cancer_profile_request from .._vendor import CancerProfilingClientMixinABC @@ -43,13 +42,8 @@ class CancerProfilingClientOperationsMixin(CancerProfilingClientMixinABC): async def _infer_cancer_profile_initial( - self, - body: Union[_models.OncoPhenotypeData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> Optional[_models.OncoPhenotypeResult]: + self, body: Union[_models.OncoPhenotypeData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: error_map = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, @@ -62,18 +56,16 @@ async def _infer_cancer_profile_initial( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[Optional[_models.OncoPhenotypeResult]] = kwargs.pop("cls", None) + cls: ClsType[JSON] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None - if isinstance(body, (IO, bytes)): + if isinstance(body, (IOBase, bytes)): _content = body else: - _content = json.dumps(body, cls=AzureJSONEncoder) # type: ignore + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_cancer_profiling_infer_cancer_profile_request( - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, + _request = build_cancer_profiling_infer_cancer_profile_request( content_type=content_type, api_version=self._config.api_version, content=_content, @@ -83,218 +75,2280 @@ async def _infer_cancer_profile_initial( path_format_arguments = { "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [200, 202]: + if response.status_code not in [202]: + if _stream: + await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) - deserialized = None response_headers = {} - if response.status_code == 200: - deserialized = _deserialize(_models.OncoPhenotypeResult, response.json()) + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) - if response.status_code == 202: - response_headers["Operation-Location"] = self._deserialize( - "str", response.headers.get("Operation-Location") - ) - response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) - response_headers["Repeatability-Result"] = self._deserialize( - "str", response.headers.get("Repeatability-Result") - ) + deserialized = _deserialize(JSON, response.json()) if cls: - return cls(pipeline_response, deserialized, response_headers) + return cls(pipeline_response, deserialized, response_headers) # type: ignore - return deserialized + return deserialized # type: ignore @overload async def begin_infer_cancer_profile( - self, - body: _models.OncoPhenotypeData, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> AsyncLROPoller[_models.OncoPhenotypeResult]: + self, body: _models.OncoPhenotypeData, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. :param body: Required. :type body: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeData - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns OncoPhenotypeResult. The - OncoPhenotypeResult is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "checkForCancerCase": bool, # Optional. An indication whether to + perform a preliminary step on the patient's documents to determine whether + they relate to a Cancer case. + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceTypes": [ + "str" # Optional. A list of inference types to be inferred + for the current request. This could be used if only part of the Onco + Phenotype inferences are required. If this list is omitted or empty, the + model will return all the inference types. + ], + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ @overload async def begin_infer_cancer_profile( - self, - body: JSON, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> AsyncLROPoller[_models.OncoPhenotypeResult]: + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. :param body: Required. :type body: JSON - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns OncoPhenotypeResult. The - OncoPhenotypeResult is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ @overload async def begin_infer_cancer_profile( - self, - body: IO, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> AsyncLROPoller[_models.OncoPhenotypeResult]: + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. :param body: Required. - :type body: IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime + :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns OncoPhenotypeResult. The - OncoPhenotypeResult is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ @distributed_trace_async async def begin_infer_cancer_profile( - self, - body: Union[_models.OncoPhenotypeData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> AsyncLROPoller[_models.OncoPhenotypeResult]: + self, body: Union[_models.OncoPhenotypeData, JSON, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. - :param body: Is one of the following types: OncoPhenotypeData, JSON, IO Required. - :type body: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeData or JSON or IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime + :param body: Is one of the following types: OncoPhenotypeData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeData or JSON or IO[bytes] :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default value is None. :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns OncoPhenotypeResult. The - OncoPhenotypeResult is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "checkForCancerCase": bool, # Optional. An indication whether to + perform a preliminary step on the patient's documents to determine whether + they relate to a Cancer case. + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceTypes": [ + "str" # Optional. A list of inference types to be inferred + for the current request. This could be used if only part of the Onco + Phenotype inferences are required. If this list is omitted or empty, the + model will return all the inference types. + ], + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[_models.OncoPhenotypeResult] = kwargs.pop("cls", None) + cls: ClsType[_models.OncoPhenotypeInferenceResult] = kwargs.pop("cls", None) polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token: Optional[str] = kwargs.pop("continuation_token", None) if cont_token is None: raw_result = await self._infer_cancer_profile_initial( - body=body, - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, - content_type=content_type, - cls=lambda x, y, z: x, - headers=_headers, - params=_params, - **kwargs + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs ) kwargs.pop("error_map", None) def get_long_running_output(pipeline_response): + response_headers = {} response = pipeline_response.http_response - deserialized = _deserialize(_models.OncoPhenotypeResult, response.json()) + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.OncoPhenotypeInferenceResult, response.json().get("result")) if cls: - return cls(pipeline_response, deserialized, {}) # type: ignore + return cls(pipeline_response, deserialized, response_headers) # type: ignore return deserialized path_format_arguments = { @@ -311,10 +2365,12 @@ def get_long_running_output(pipeline_response): else: polling_method = polling if cont_token: - return AsyncLROPoller.from_continuation_token( + return AsyncLROPoller[_models.OncoPhenotypeInferenceResult].from_continuation_token( polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output, ) - return AsyncLROPoller(self._client, raw_result, get_long_running_output, polling_method) # type: ignore + return AsyncLROPoller[_models.OncoPhenotypeInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/__init__.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/__init__.py index a962e8202086a..433c331292b22 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/__init__.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/__init__.py @@ -8,27 +8,46 @@ from ._models import ClinicalCodedElement from ._models import ClinicalNoteEvidence +from ._models import CodeableConcept +from ._models import Coding +from ._models import DocumentAdministrativeMetadata +from ._models import DocumentAuthor from ._models import DocumentContent +from ._models import Element +from ._models import Encounter from ._models import Error +from ._models import Extension +from ._models import HealthInsightsOperationStatus +from ._models import Identifier from ._models import InferenceEvidence from ._models import InnerError +from ._models import Meta from ._models import OncoPhenotypeData from ._models import OncoPhenotypeInference +from ._models import OncoPhenotypeInferenceResult from ._models import OncoPhenotypeModelConfiguration from ._models import OncoPhenotypePatientResult -from ._models import OncoPhenotypeResult -from ._models import OncoPhenotypeResults +from ._models import OrderedProcedure +from ._models import PatientDetails from ._models import PatientDocument -from ._models import PatientInfo from ._models import PatientRecord +from ._models import Period +from ._models import Quantity +from ._models import Range +from ._models import Ratio +from ._models import Reference +from ._models import Resource +from ._models import SampledData +from ._models import TimePeriod from ._enums import ClinicalDocumentType from ._enums import DocumentContentSourceType from ._enums import DocumentType +from ._enums import EncounterClass from ._enums import JobStatus from ._enums import OncoPhenotypeInferenceType -from ._enums import PatientInfoSex -from ._enums import RepeatabilityResultType +from ._enums import PatientSex +from ._enums import SpecialtyType from ._patch import __all__ as _patch_all from ._patch import * # pylint: disable=unused-wildcard-import from ._patch import patch_sdk as _patch_sdk @@ -36,26 +55,45 @@ __all__ = [ "ClinicalCodedElement", "ClinicalNoteEvidence", + "CodeableConcept", + "Coding", + "DocumentAdministrativeMetadata", + "DocumentAuthor", "DocumentContent", + "Element", + "Encounter", "Error", + "Extension", + "HealthInsightsOperationStatus", + "Identifier", "InferenceEvidence", "InnerError", + "Meta", "OncoPhenotypeData", "OncoPhenotypeInference", + "OncoPhenotypeInferenceResult", "OncoPhenotypeModelConfiguration", "OncoPhenotypePatientResult", - "OncoPhenotypeResult", - "OncoPhenotypeResults", + "OrderedProcedure", + "PatientDetails", "PatientDocument", - "PatientInfo", "PatientRecord", + "Period", + "Quantity", + "Range", + "Ratio", + "Reference", + "Resource", + "SampledData", + "TimePeriod", "ClinicalDocumentType", "DocumentContentSourceType", "DocumentType", + "EncounterClass", "JobStatus", "OncoPhenotypeInferenceType", - "PatientInfoSex", - "RepeatabilityResultType", + "PatientSex", + "SpecialtyType", ] __all__.extend([p for p in _patch_all if p not in __all__]) _patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_enums.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_enums.py index 82887a036e6b9..b86e4252f52c7 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_enums.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_enums.py @@ -16,11 +16,11 @@ class ClinicalDocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): CONSULTATION = "consultation" DISCHARGE_SUMMARY = "dischargeSummary" HISTORY_AND_PHYSICAL = "historyAndPhysical" + RADIOLOGY_REPORT = "radiologyReport" PROCEDURE = "procedure" PROGRESS = "progress" - IMAGING = "imaging" LABORATORY = "laboratory" - PATHOLOGY = "pathology" + PATHOLOGY_REPORT = "pathologyReport" class DocumentContentSourceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -30,7 +30,9 @@ class DocumentContentSourceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): """ INLINE = "inline" + """The content is given as a string (for instance, text).""" REFERENCE = "reference" + """The content is given as a URI.""" class DocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -44,6 +46,35 @@ class DocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): GENOMIC_SEQUENCING = "genomicSequencing" +class EncounterClass(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR + value set--http://....). + """ + + IN_PATIENT = "inpatient" + """A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned + to a location where patients generally stay at least overnight and provided with room, board, + and continuous nursing service.""" + AMBULATORY = "ambulatory" + """The term ambulatory usually implies that the patient has come to the location and is not + assigned to a bed. Sometimes referred to as an outpatient encounter.""" + OBSERVATION = "observation" + """An encounter where the patient usually will start in different encounter, such as one in the + emergency department but then transition to this type of encounter because they require a + significant period of treatment and monitoring to determine whether or not their condition + warrants an inpatient admission or discharge.""" + EMERGENCY = "emergency" + """A patient encounter that takes place at a dedicated healthcare service delivery location where + the patient receives immediate evaluation and treatment, provided until the patient can be + discharged or responsibility for the patient's care is transferred elsewhere (for example, the + patient could be admitted as an inpatient or transferred to another facility.""" + VIRTUAL = "virtual" + """A patient encounter where the patient is not physically present for the encounter, such as in a + telehealth encounter, phone call, or electronic communication.""" + HEALTH_HOME = "healthHome" + """Healthcare encounter that takes place in the residence of the patient or a designee""" + + class JobStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): """The status of the processing job.""" @@ -51,7 +82,7 @@ class JobStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): RUNNING = "running" SUCCEEDED = "succeeded" FAILED = "failed" - PARTIALLY_COMPLETED = "partiallyCompleted" + CANCELED = "canceled" class OncoPhenotypeInferenceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -65,9 +96,10 @@ class OncoPhenotypeInferenceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): PATHOLOGIC_STAGE_T = "pathologicStageT" PATHOLOGIC_STAGE_N = "pathologicStageN" PATHOLOGIC_STAGE_M = "pathologicStageM" + DIAGNOSIS_DATE = "diagnosisDate" -class PatientInfoSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): +class PatientSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): """The patient's sex.""" FEMALE = "female" @@ -75,8 +107,10 @@ class PatientInfoSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): UNSPECIFIED = "unspecified" -class RepeatabilityResultType(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Type of RepeatabilityResultType.""" +class SpecialtyType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the type of the Specialty.""" - ACCEPTED = "accepted" - REJECTED = "rejected" + PATHOLOGY = "pathology" + """pathology""" + RADIOLOGY = "radiology" + """radiology""" diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_models.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_models.py index f91de6cc4e797..e5460b5aa588e 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_models.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_models.py @@ -21,7 +21,7 @@ class ClinicalCodedElement(_model_base.Model): """A piece of clinical information, expressed as a code in a clinical coding system. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar system: The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. :vartype system: str @@ -34,13 +34,13 @@ class ClinicalCodedElement(_model_base.Model): """ system: str = rest_field() - """The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. """ + """The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required.""" code: str = rest_field() - """The code within the given clinical coding system. Required. """ + """The code within the given clinical coding system. Required.""" name: Optional[str] = rest_field() - """The name of this coded concept in the coding system. """ + """The name of this coded concept in the coding system.""" value: Optional[str] = rest_field() - """A value associated with the code within the given clinical coding system. """ + """A value associated with the code within the given clinical coding system.""" @overload def __init__( @@ -67,7 +67,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class ClinicalNoteEvidence(_model_base.Model): """A piece of evidence from a clinical note (text document). - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar id: The identifier of the document containing the evidence. Required. :vartype id: str @@ -80,13 +80,13 @@ class ClinicalNoteEvidence(_model_base.Model): """ id: str = rest_field() - """The identifier of the document containing the evidence. Required. """ + """The identifier of the document containing the evidence. Required.""" text: Optional[str] = rest_field() - """The actual text span which is evidence for the inference. """ + """The actual text span which is evidence for the inference.""" offset: int = rest_field() - """The start index of the evidence text span in the document (0 based). Required. """ + """The start index of the evidence text span in the document (0 based). Required.""" length: int = rest_field() - """The length of the evidence text span. Required. """ + """The length of the evidence text span. Required.""" @overload def __init__( @@ -110,35 +110,959 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) +class Element(_model_base.Model): + """The base definition for all elements contained inside a resource. + Based on `FHIR Element `_. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.cancerprofiling.models.Extension] + """ + + id: Optional[str] = rest_field() + """Unique id for inter-element referencing.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CodeableConcept(Element): + """Concept - reference to a terminology or just text + Based on `FHIR CodeableConcept `_. + + :ivar coding: Code defined by a terminology system. + :vartype coding: list[~azure.healthinsights.cancerprofiling.models.Coding] + :ivar text: Plain text representation of the concept. + :vartype text: str + """ + + coding: Optional[List["_models.Coding"]] = rest_field() + """Code defined by a terminology system.""" + text: Optional[str] = rest_field() + """Plain text representation of the concept.""" + + @overload + def __init__( + self, + *, + coding: Optional[List["_models.Coding"]] = None, + text: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Coding(Element): + """A Coding is a representation of a defined concept using a symbol from a defined "code system". + Based on `FHIR Coding `_. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.cancerprofiling.models.Extension] + :ivar system: Identity of the terminology system. + :vartype system: str + :ivar version: Version of the system - if relevant. + :vartype version: str + :ivar code: Symbol in syntax defined by the system. + :vartype code: str + :ivar display: Representation defined by the system. + :vartype display: str + """ + + system: Optional[str] = rest_field() + """Identity of the terminology system.""" + version: Optional[str] = rest_field() + """Version of the system - if relevant.""" + code: Optional[str] = rest_field() + """Symbol in syntax defined by the system.""" + display: Optional[str] = rest_field() + """Representation defined by the system.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + system: Optional[str] = None, + version: Optional[str] = None, + code: Optional[str] = None, + display: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAdministrativeMetadata(_model_base.Model): + """Document administrative metadata. + + :ivar ordered_procedures: List of procedure information associated with the document. + :vartype ordered_procedures: + list[~azure.healthinsights.cancerprofiling.models.OrderedProcedure] + :ivar encounter_id: Reference to the encounter associated with the document. + :vartype encounter_id: str + """ + + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = rest_field(name="orderedProcedures") + """List of procedure information associated with the document.""" + encounter_id: Optional[str] = rest_field(name="encounterId") + """Reference to the encounter associated with the document.""" + + @overload + def __init__( + self, + *, + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = None, + encounter_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAuthor(_model_base.Model): + """Document author. + + :ivar id: author id. + :vartype id: str + :ivar full_name: Text representation of the full name. + :vartype full_name: str + """ + + id: Optional[str] = rest_field() + """author id.""" + full_name: Optional[str] = rest_field(name="fullName") + """Text representation of the full name.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + full_name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + class DocumentContent(_model_base.Model): """The content of the patient document. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. + + :ivar source_type: The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: "inline" and "reference". + :vartype source_type: str or + ~azure.healthinsights.cancerprofiling.models.DocumentContentSourceType + :ivar value: The content of the document, given either inline (as a string) or as a reference + (URI). Required. + :vartype value: str + """ + + source_type: Union[str, "_models.DocumentContentSourceType"] = rest_field(name="sourceType") + """The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: \"inline\" and \"reference\".""" + value: str = rest_field() + """The content of the document, given either inline (as a string) or as a reference (URI). + Required.""" + + @overload + def __init__( + self, + *, + source_type: Union[str, "_models.DocumentContentSourceType"], + value: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Encounter(_model_base.Model): + """visit/encounter information. + + All required parameters must be populated in order to send to server. + + :ivar id: The id of the visit. Required. + :vartype id: str + :ivar period: Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end + to indicate the discharge time. + :vartype period: ~azure.healthinsights.cancerprofiling.models.TimePeriod + :ivar class_property: The class of the encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + :vartype class_property: str or ~azure.healthinsights.cancerprofiling.models.EncounterClass + """ + + id: str = rest_field() + """The id of the visit. Required.""" + period: Optional["_models.TimePeriod"] = rest_field() + """Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to + indicate the discharge time.""" + class_property: Optional[Union[str, "_models.EncounterClass"]] = rest_field(name="class") + """The class of the encounter. Known values are: \"inpatient\", \"ambulatory\", \"observation\", + \"emergency\", \"virtual\", and \"healthHome\".""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + period: Optional["_models.TimePeriod"] = None, + class_property: Optional[Union[str, "_models.EncounterClass"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Error(_model_base.Model): + """The error object. + + All required parameters must be populated in order to send to server. + + :ivar code: One of a server-defined set of error codes. Required. + :vartype code: str + :ivar message: A human-readable representation of the error. Required. + :vartype message: str + :ivar target: The target of the error. + :vartype target: str + :ivar details: An array of details about specific errors that led to this reported error. + :vartype details: list[~azure.healthinsights.cancerprofiling.models.Error] + :ivar innererror: An object containing more specific information than the current object about + the error. + :vartype innererror: ~azure.healthinsights.cancerprofiling.models.InnerError + """ + + code: str = rest_field() + """One of a server-defined set of error codes. Required.""" + message: str = rest_field() + """A human-readable representation of the error. Required.""" + target: Optional[str] = rest_field() + """The target of the error.""" + details: Optional[List["_models.Error"]] = rest_field() + """An array of details about specific errors that led to this reported error.""" + innererror: Optional["_models.InnerError"] = rest_field() + """An object containing more specific information than the current object about the error.""" + + @overload + def __init__( + self, + *, + code: str, + message: str, + target: Optional[str] = None, + details: Optional[List["_models.Error"]] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Extension(Element): # pylint: disable=too-many-instance-attributes + """Base for all elements + Based on `FHIR Element `_. + + All required parameters must be populated in order to send to server. + + :ivar url: Source of the definition for the extension code - a logical name or a URL. Required. + :vartype url: str + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.cancerprofiling.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.cancerprofiling.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.cancerprofiling.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.cancerprofiling.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.cancerprofiling.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.cancerprofiling.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.cancerprofiling.models.Reference + """ + + url: str = rest_field() + """Source of the definition for the extension code - a logical name or a URL. Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + + @overload + def __init__( + self, + *, + url: str, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class HealthInsightsOperationStatus(_model_base.Model): + """Provides status details for long running operations. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: The unique ID of the operation. Required. + :vartype id: str + :ivar status: The status of the operation. Required. Known values are: "notStarted", "running", + "succeeded", "failed", and "canceled". + :vartype status: str or ~azure.healthinsights.cancerprofiling.models.JobStatus + :ivar created_date_time: The date and time when the processing job was created. + :vartype created_date_time: ~datetime.datetime + :ivar expiration_date_time: The date and time when the processing job is set to expire. + :vartype expiration_date_time: ~datetime.datetime + :ivar last_update_date_time: The date and time when the processing job was last updated. + :vartype last_update_date_time: ~datetime.datetime + :ivar error: Error object that describes the error when status is "Failed". + :vartype error: ~azure.healthinsights.cancerprofiling.models.Error + :ivar result: The result of the operation. + :vartype result: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult + """ + + id: str = rest_field(visibility=["read"]) + """The unique ID of the operation. Required.""" + status: Union[str, "_models.JobStatus"] = rest_field(visibility=["read"]) + """The status of the operation. Required. Known values are: \"notStarted\", \"running\", + \"succeeded\", \"failed\", and \"canceled\".""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was created.""" + expiration_date_time: Optional[datetime.datetime] = rest_field( + name="expirationDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job is set to expire.""" + last_update_date_time: Optional[datetime.datetime] = rest_field( + name="lastUpdateDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was last updated.""" + error: Optional["_models.Error"] = rest_field() + """Error object that describes the error when status is \"Failed\".""" + result: Optional["_models.OncoPhenotypeInferenceResult"] = rest_field() + """The result of the operation.""" + + @overload + def __init__( + self, + *, + error: Optional["_models.Error"] = None, + result: Optional["_models.OncoPhenotypeInferenceResult"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Identifier(Element): + """An identifier intended for computation + Based on `FHIR Identifier `_. + + :ivar use: usual | official | temp | secondary | old (If known). + :vartype use: str + :ivar type: Description of identifier. + :vartype type: ~azure.healthinsights.cancerprofiling.models.CodeableConcept + :ivar system: The namespace for the identifier value. + :vartype system: str + :ivar value: The value that is unique. + :vartype value: str + :ivar period: Time period when id is/was valid for use. + :vartype period: ~azure.healthinsights.cancerprofiling.models.Period + :ivar assigner: Organization that issued id (may be just text). + :vartype assigner: ~azure.healthinsights.cancerprofiling.models.Reference + """ + + use: Optional[str] = rest_field() + """usual | official | temp | secondary | old (If known).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Description of identifier.""" + system: Optional[str] = rest_field() + """The namespace for the identifier value.""" + value: Optional[str] = rest_field() + """The value that is unique.""" + period: Optional["_models.Period"] = rest_field() + """Time period when id is/was valid for use.""" + assigner: Optional["_models.Reference"] = rest_field() + """Organization that issued id (may be just text).""" + + @overload + def __init__( + self, + *, + use: Optional[str] = None, + type: Optional["_models.CodeableConcept"] = None, + system: Optional[str] = None, + value: Optional[str] = None, + period: Optional["_models.Period"] = None, + assigner: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class InferenceEvidence(_model_base.Model): + """A piece of evidence corresponding to an inference. + + :ivar patient_data_evidence: A piece of evidence from a clinical note (text document). + :vartype patient_data_evidence: + ~azure.healthinsights.cancerprofiling.models.ClinicalNoteEvidence + :ivar patient_info_evidence: A piece of clinical information, expressed as a code in a clinical + coding + system. + :vartype patient_info_evidence: + ~azure.healthinsights.cancerprofiling.models.ClinicalCodedElement + :ivar importance: A value indicating how important this piece of evidence is for the inference. + :vartype importance: float + """ + + patient_data_evidence: Optional["_models.ClinicalNoteEvidence"] = rest_field(name="patientDataEvidence") + """A piece of evidence from a clinical note (text document).""" + patient_info_evidence: Optional["_models.ClinicalCodedElement"] = rest_field(name="patientInfoEvidence") + """A piece of clinical information, expressed as a code in a clinical coding + system.""" + importance: Optional[float] = rest_field() + """A value indicating how important this piece of evidence is for the inference.""" + + @overload + def __init__( + self, + *, + patient_data_evidence: Optional["_models.ClinicalNoteEvidence"] = None, + patient_info_evidence: Optional["_models.ClinicalCodedElement"] = None, + importance: Optional[float] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class InnerError(_model_base.Model): + """An object containing more specific information about the error. As per Microsoft One API + guidelines - + https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + + :ivar code: One of a server-defined set of error codes. + :vartype code: str + :ivar innererror: Inner error. + :vartype innererror: ~azure.healthinsights.cancerprofiling.models.InnerError + """ + + code: Optional[str] = rest_field() + """One of a server-defined set of error codes.""" + innererror: Optional["_models.InnerError"] = rest_field() + """Inner error.""" + + @overload + def __init__( + self, + *, + code: Optional[str] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Meta(_model_base.Model): + """Metadata about a resource + Based on `FHIR Meta `_. + + :ivar version_id: The version specific identifier, as it appears in the version portion of the + URL. This value changes when the resource is created, updated, or deleted. + :vartype version_id: str + :ivar last_updated: When the resource last changed - e.g. when the version changed. + :vartype last_updated: str + :ivar source: A uri that identifies the source system of the resource. This provides a minimal + amount of Provenance information that can be used to track or differentiate the source of + information in the resource. The source may identify another FHIR server, document, message, + database, etc. + :vartype source: str + :ivar profile: A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_. + :vartype profile: list[str] + :ivar security: Security labels applied to this resource. These tags connect specific resources + to the overall security policy and infrastructure. + :vartype security: list[~azure.healthinsights.cancerprofiling.models.Coding] + :ivar tag: Tags applied to this resource. Tags are intended to be used to identify and relate + resources to process and workflow, and applications are not required to consider the tags when + interpreting the meaning of a resource. + :vartype tag: list[~azure.healthinsights.cancerprofiling.models.Coding] + """ + + version_id: Optional[str] = rest_field(name="versionId") + """The version specific identifier, as it appears in the version portion of the URL. This value + changes when the resource is created, updated, or deleted.""" + last_updated: Optional[str] = rest_field(name="lastUpdated") + """When the resource last changed - e.g. when the version changed.""" + source: Optional[str] = rest_field() + """A uri that identifies the source system of the resource. This provides a minimal amount of + Provenance information that can be used to track or differentiate the source of information in + the resource. The source may identify another FHIR server, document, message, database, etc.""" + profile: Optional[List[str]] = rest_field() + """A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_.""" + security: Optional[List["_models.Coding"]] = rest_field() + """Security labels applied to this resource. These tags connect specific resources to the overall + security policy and infrastructure.""" + tag: Optional[List["_models.Coding"]] = rest_field() + """Tags applied to this resource. Tags are intended to be used to identify and relate resources to + process and workflow, and applications are not required to consider the tags when interpreting + the meaning of a resource.""" + + @overload + def __init__( + self, + *, + version_id: Optional[str] = None, + last_updated: Optional[str] = None, + source: Optional[str] = None, + profile: Optional[List[str]] = None, + security: Optional[List["_models.Coding"]] = None, + tag: Optional[List["_models.Coding"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OncoPhenotypeData(_model_base.Model): + """The body of the Onco Phenotype request. + + All required parameters must be populated in order to send to server. + + :ivar patients: The list of patients, including their clinical information and data. Required. + :vartype patients: list[~azure.healthinsights.cancerprofiling.models.PatientRecord] + :ivar configuration: Configuration affecting the Onco Phenotype model's inference. + :vartype configuration: + ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeModelConfiguration + """ + + patients: List["_models.PatientRecord"] = rest_field() + """The list of patients, including their clinical information and data. Required.""" + configuration: Optional["_models.OncoPhenotypeModelConfiguration"] = rest_field() + """Configuration affecting the Onco Phenotype model's inference.""" + + @overload + def __init__( + self, + *, + patients: List["_models.PatientRecord"], + configuration: Optional["_models.OncoPhenotypeModelConfiguration"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OncoPhenotypeInference(_model_base.Model): + """An inference made by the Onco Phenotype model regarding a patient. + + All required parameters must be populated in order to send to server. + + :ivar type: The type of the Onco Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", "clinicalStageM", "pathologicStageT", + "pathologicStageN", "pathologicStageM", and "diagnosisDate". + :vartype type: str or ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceType + :ivar value: The value of the inference, as relevant for the given inference type. Required. + :vartype value: str + :ivar description: The description corresponding to the inference value. + :vartype description: str + :ivar confidence_score: Confidence score for this inference. + :vartype confidence_score: float + :ivar evidence: The evidence corresponding to the inference value. + :vartype evidence: list[~azure.healthinsights.cancerprofiling.models.InferenceEvidence] + :ivar case_id: An identifier for a clinical case, if there are multiple clinical cases + regarding the same patient. + :vartype case_id: str + """ + + type: Union[str, "_models.OncoPhenotypeInferenceType"] = rest_field() + """The type of the Onco Phenotype inference. Required. Known values are: \"tumorSite\", + \"histology\", \"clinicalStageT\", \"clinicalStageN\", \"clinicalStageM\", + \"pathologicStageT\", \"pathologicStageN\", \"pathologicStageM\", and \"diagnosisDate\".""" + value: str = rest_field() + """The value of the inference, as relevant for the given inference type. Required.""" + description: Optional[str] = rest_field() + """The description corresponding to the inference value.""" + confidence_score: Optional[float] = rest_field(name="confidenceScore") + """Confidence score for this inference.""" + evidence: Optional[List["_models.InferenceEvidence"]] = rest_field() + """The evidence corresponding to the inference value.""" + case_id: Optional[str] = rest_field(name="caseId") + """An identifier for a clinical case, if there are multiple clinical cases regarding the same + patient.""" + + @overload + def __init__( + self, + *, + type: Union[str, "_models.OncoPhenotypeInferenceType"], + value: str, + description: Optional[str] = None, + confidence_score: Optional[float] = None, + evidence: Optional[List["_models.InferenceEvidence"]] = None, + case_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OncoPhenotypeInferenceResult(_model_base.Model): + """The inference results for the Onco Phenotype request. + + All required parameters must be populated in order to send to server. + + :ivar patient_results: Results for the patients given in the request. Required. + :vartype patient_results: + list[~azure.healthinsights.cancerprofiling.models.OncoPhenotypePatientResult] + :ivar model_version: The version of the model used for inference, expressed as the model date. + Required. + :vartype model_version: str + """ + + patient_results: List["_models.OncoPhenotypePatientResult"] = rest_field(name="patientResults") + """Results for the patients given in the request. Required.""" + model_version: str = rest_field(name="modelVersion") + """The version of the model used for inference, expressed as the model date. Required.""" + + @overload + def __init__( + self, + *, + patient_results: List["_models.OncoPhenotypePatientResult"], + model_version: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OncoPhenotypeModelConfiguration(_model_base.Model): + """Configuration affecting the Onco Phenotype model's inference. + + :ivar verbose: An indication whether the model should produce verbose output. + :vartype verbose: bool + :ivar include_evidence: An indication whether the model's output should include evidence for + the inferences. + :vartype include_evidence: bool + :ivar inference_types: A list of inference types to be inferred for the current request. + This could be used if only part of the Onco Phenotype inferences are required. + If this list is omitted or empty, the model will return all the inference types. + :vartype inference_types: list[str or + ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceType] + :ivar check_for_cancer_case: An indication whether to perform a preliminary step on the + patient's documents to determine whether they relate to a Cancer case. + :vartype check_for_cancer_case: bool + """ + + verbose: Optional[bool] = rest_field() + """An indication whether the model should produce verbose output.""" + include_evidence: Optional[bool] = rest_field(name="includeEvidence") + """An indication whether the model's output should include evidence for the inferences.""" + inference_types: Optional[List[Union[str, "_models.OncoPhenotypeInferenceType"]]] = rest_field( + name="inferenceTypes" + ) + """A list of inference types to be inferred for the current request. + This could be used if only part of the Onco Phenotype inferences are required. + If this list is omitted or empty, the model will return all the inference types.""" + check_for_cancer_case: Optional[bool] = rest_field(name="checkForCancerCase") + """An indication whether to perform a preliminary step on the patient's documents to determine + whether they relate to a Cancer case.""" + + @overload + def __init__( + self, + *, + verbose: Optional[bool] = None, + include_evidence: Optional[bool] = None, + inference_types: Optional[List[Union[str, "_models.OncoPhenotypeInferenceType"]]] = None, + check_for_cancer_case: Optional[bool] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OncoPhenotypePatientResult(_model_base.Model): + """The results of the model's work for a single patient. + + All required parameters must be populated in order to send to server. + + :ivar patient_id: The identifier given for the patient in the request. Required. + :vartype patient_id: str + :ivar inferences: The model's inferences for the given patient. Required. + :vartype inferences: list[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInference] + """ + + patient_id: str = rest_field(name="patientId") + """The identifier given for the patient in the request. Required.""" + inferences: List["_models.OncoPhenotypeInference"] = rest_field() + """The model's inferences for the given patient. Required.""" + + @overload + def __init__( + self, + *, + patient_id: str, + inferences: List["_models.OncoPhenotypeInference"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + - :ivar source_type: The type of the content's source. - In case the source type is 'inline', the content is given as a string (for instance, text). - In case the source type is 'reference', the content is given as a URI. Required. Known values - are: "inline" and "reference". - :vartype source_type: str or - ~azure.healthinsights.cancerprofiling.models.DocumentContentSourceType - :ivar value: The content of the document, given either inline (as a string) or as a reference - (URI). Required. - :vartype value: str +class OrderedProcedure(_model_base.Model): + """Procedure information. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.cancerprofiling.models.Extension] + :ivar code: Procedure code. + :vartype code: ~azure.healthinsights.cancerprofiling.models.CodeableConcept + :ivar description: Procedure description. + :vartype description: str """ - source_type: Union[str, "_models.DocumentContentSourceType"] = rest_field(name="sourceType") - """The type of the content's source. In case the source type is 'inline', the content is given as a string (for - instance, text). In case the source type is 'reference', the content is given as a URI. Required. Known values - are: \"inline\" and \"reference\". """ - value: str = rest_field() - """The content of the document, given either inline (as a string) or as a reference (URI). Required. """ + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Procedure code.""" + description: Optional[str] = rest_field() + """Procedure description.""" @overload def __init__( self, *, - source_type: Union[str, "_models.DocumentContentSourceType"], - value: str, + extension: Optional[List["_models.Extension"]] = None, + code: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, ): ... @@ -153,45 +1077,32 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class Error(_model_base.Model): - """The error object. - - All required parameters must be populated in order to send to Azure. +class PatientDetails(_model_base.Model): + """Patient structured information, including demographics and known structured clinical + information. - :ivar code: One of a server-defined set of error codes. Required. - :vartype code: str - :ivar message: A human-readable representation of the error. Required. - :vartype message: str - :ivar target: The target of the error. - :vartype target: str - :ivar details: An array of details about specific errors that led to this reported error. - Required. - :vartype details: list[~azure.healthinsights.cancerprofiling.models.Error] - :ivar innererror: An object containing more specific information than the current object about - the error. - :vartype innererror: ~azure.healthinsights.cancerprofiling.models.InnerError + :ivar sex: The patient's sex. Known values are: "female", "male", and "unspecified". + :vartype sex: str or ~azure.healthinsights.cancerprofiling.models.PatientSex + :ivar birth_date: The patient's date of birth. + :vartype birth_date: ~datetime.date + :ivar clinical_info: Known clinical information for the patient, structured. + :vartype clinical_info: list[~azure.healthinsights.cancerprofiling.models.Resource] """ - code: str = rest_field() - """One of a server-defined set of error codes. Required. """ - message: str = rest_field() - """A human-readable representation of the error. Required. """ - target: Optional[str] = rest_field() - """The target of the error. """ - details: List["_models.Error"] = rest_field() - """An array of details about specific errors that led to this reported error. Required. """ - innererror: Optional["_models.InnerError"] = rest_field() - """An object containing more specific information than the current object about the error. """ + sex: Optional[Union[str, "_models.PatientSex"]] = rest_field() + """The patient's sex. Known values are: \"female\", \"male\", and \"unspecified\".""" + birth_date: Optional[datetime.date] = rest_field(name="birthDate") + """The patient's date of birth.""" + clinical_info: Optional[List["_models.Resource"]] = rest_field(name="clinicalInfo") + """Known clinical information for the patient, structured.""" @overload def __init__( self, *, - code: str, - message: str, - details: List["_models.Error"], - target: Optional[str] = None, - innererror: Optional["_models.InnerError"] = None, + sex: Optional[Union[str, "_models.PatientSex"]] = None, + birth_date: Optional[datetime.date] = None, + clinical_info: Optional[List["_models.Resource"]] = None, ): ... @@ -206,36 +1117,79 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class InferenceEvidence(_model_base.Model): - """A piece of evidence corresponding to an inference. +class PatientDocument(_model_base.Model): + """A clinical document related to a patient. Document here is in the wide sense - not just a text + document (note). - :ivar patient_data_evidence: A piece of evidence from a clinical note (text document). - :vartype patient_data_evidence: - ~azure.healthinsights.cancerprofiling.models.ClinicalNoteEvidence - :ivar patient_info_evidence: A piece of clinical information, expressed as a code in a clinical - coding - system. - :vartype patient_info_evidence: - ~azure.healthinsights.cancerprofiling.models.ClinicalCodedElement - :ivar importance: A value indicating how important this piece of evidence is for the inference. - :vartype importance: float + All required parameters must be populated in order to send to server. + + :ivar type: The type of the patient document, such as 'note' (text document) or 'fhirBundle' + (FHIR JSON document). Required. Known values are: "note", "fhirBundle", "dicom", and + "genomicSequencing". + :vartype type: str or ~azure.healthinsights.cancerprofiling.models.DocumentType + :ivar clinical_type: The type of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", "procedure", "progress", + "laboratory", and "pathologyReport". + :vartype clinical_type: str or + ~azure.healthinsights.cancerprofiling.models.ClinicalDocumentType + :ivar id: A given identifier for the document. Has to be unique across all documents for a + single patient. Required. + :vartype id: str + :ivar language: A 2 letter ISO 639-1 representation of the language of the document. + :vartype language: str + :ivar created_date_time: The date and time when the document was created. + :vartype created_date_time: ~datetime.datetime + :ivar authors: Document author(s). + :vartype authors: list[~azure.healthinsights.cancerprofiling.models.DocumentAuthor] + :ivar specialty_type: specialty type the document. Known values are: "pathology" and + "radiology". + :vartype specialty_type: str or ~azure.healthinsights.cancerprofiling.models.SpecialtyType + :ivar administrative_metadata: Administrative metadata for the document. + :vartype administrative_metadata: + ~azure.healthinsights.cancerprofiling.models.DocumentAdministrativeMetadata + :ivar content: The content of the patient document. Required. + :vartype content: ~azure.healthinsights.cancerprofiling.models.DocumentContent """ - patient_data_evidence: Optional["_models.ClinicalNoteEvidence"] = rest_field(name="patientDataEvidence") - """A piece of evidence from a clinical note (text document). """ - patient_info_evidence: Optional["_models.ClinicalCodedElement"] = rest_field(name="patientInfoEvidence") - """A piece of clinical information, expressed as a code in a clinical coding -system. """ - importance: Optional[float] = rest_field() - """A value indicating how important this piece of evidence is for the inference. """ + type: Union[str, "_models.DocumentType"] = rest_field() + """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON + document). Required. Known values are: \"note\", \"fhirBundle\", \"dicom\", and + \"genomicSequencing\".""" + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = rest_field(name="clinicalType") + """The type of the clinical document. Known values are: \"consultation\", \"dischargeSummary\", + \"historyAndPhysical\", \"radiologyReport\", \"procedure\", \"progress\", \"laboratory\", and + \"pathologyReport\".""" + id: str = rest_field() + """A given identifier for the document. Has to be unique across all documents for a single + patient. Required.""" + language: Optional[str] = rest_field() + """A 2 letter ISO 639-1 representation of the language of the document.""" + created_date_time: Optional[datetime.datetime] = rest_field(name="createdDateTime", format="rfc3339") + """The date and time when the document was created.""" + authors: Optional[List["_models.DocumentAuthor"]] = rest_field() + """Document author(s).""" + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = rest_field(name="specialtyType") + """specialty type the document. Known values are: \"pathology\" and \"radiology\".""" + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = rest_field( + name="administrativeMetadata" + ) + """Administrative metadata for the document.""" + content: "_models.DocumentContent" = rest_field() + """The content of the patient document. Required.""" @overload def __init__( self, *, - patient_data_evidence: Optional["_models.ClinicalNoteEvidence"] = None, - patient_info_evidence: Optional["_models.ClinicalCodedElement"] = None, - importance: Optional[float] = None, + type: Union[str, "_models.DocumentType"], + id: str, # pylint: disable=redefined-builtin + content: "_models.DocumentContent", + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = None, + language: Optional[str] = None, + created_date_time: Optional[datetime.datetime] = None, + authors: Optional[List["_models.DocumentAuthor"]] = None, + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = None, + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = None, ): ... @@ -250,30 +1204,42 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class InnerError(_model_base.Model): - """An object containing more specific information about the error. As per Microsoft One API - guidelines - - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. +class PatientRecord(_model_base.Model): + """A patient record, including their clinical information and data. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. - :ivar code: One of a server-defined set of error codes. Required. - :vartype code: str - :ivar innererror: Inner error. - :vartype innererror: ~azure.healthinsights.cancerprofiling.models.InnerError + :ivar id: A given identifier for the patient. Has to be unique across all patients in a single + request. Required. + :vartype id: str + :ivar info: Patient structured information, including demographics and known structured + clinical information. + :vartype info: ~azure.healthinsights.cancerprofiling.models.PatientDetails + :ivar encounters: Patient encounters/visits. + :vartype encounters: list[~azure.healthinsights.cancerprofiling.models.Encounter] + :ivar patient_documents: Patient unstructured clinical data, given as documents. + :vartype patient_documents: list[~azure.healthinsights.cancerprofiling.models.PatientDocument] """ - code: str = rest_field() - """One of a server-defined set of error codes. Required. """ - innererror: Optional["_models.InnerError"] = rest_field() - """Inner error. """ + id: str = rest_field() + """A given identifier for the patient. Has to be unique across all patients in a single request. + Required.""" + info: Optional["_models.PatientDetails"] = rest_field() + """Patient structured information, including demographics and known structured clinical + information.""" + encounters: Optional[List["_models.Encounter"]] = rest_field() + """Patient encounters/visits.""" + patient_documents: Optional[List["_models.PatientDocument"]] = rest_field(name="patientDocuments") + """Patient unstructured clinical data, given as documents.""" @overload def __init__( self, *, - code: str, - innererror: Optional["_models.InnerError"] = None, + id: str, # pylint: disable=redefined-builtin + info: Optional["_models.PatientDetails"] = None, + encounters: Optional[List["_models.Encounter"]] = None, + patient_documents: Optional[List["_models.PatientDocument"]] = None, ): ... @@ -288,29 +1254,27 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class OncoPhenotypeData(_model_base.Model): - """OncoPhenotypeData. - - All required parameters must be populated in order to send to Azure. +class Period(Element): + """A time period defined by a start and end date and optionally time + Based on `FHIR Period `_. - :ivar patients: The list of patients, including their clinical information and data. Required. - :vartype patients: list[~azure.healthinsights.cancerprofiling.models.PatientRecord] - :ivar configuration: Configuration affecting the Onco Phenotype model's inference. - :vartype configuration: - ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeModelConfiguration + :ivar start: Starting time with inclusive boundary. + :vartype start: str + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: str """ - patients: List["_models.PatientRecord"] = rest_field() - """The list of patients, including their clinical information and data. Required. """ - configuration: Optional["_models.OncoPhenotypeModelConfiguration"] = rest_field() - """Configuration affecting the Onco Phenotype model's inference. """ + start: Optional[str] = rest_field() + """Starting time with inclusive boundary.""" + end: Optional[str] = rest_field() + """End time with inclusive boundary, if not ongoing.""" @overload def __init__( self, *, - patients: List["_models.PatientRecord"], - configuration: Optional["_models.OncoPhenotypeModelConfiguration"] = None, + start: Optional[str] = None, + end: Optional[str] = None, ): ... @@ -325,53 +1289,42 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class OncoPhenotypeInference(_model_base.Model): - """An inference made by the Onco Phenotype model regarding a patient. +class Quantity(Element): + """A measured or measurable amount + Based on `FHIR Quantity `_. - All required parameters must be populated in order to send to Azure. - - :ivar type: The type of the Onco Phenotype inference. Required. Known values are: "tumorSite", - "histology", "clinicalStageT", "clinicalStageN", "clinicalStageM", "pathologicStageT", - "pathologicStageN", and "pathologicStageM". - :vartype type: str or ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceType - :ivar value: The value of the inference, as relevant for the given inference type. Required. - :vartype value: str - :ivar description: The description corresponding to the inference value. - :vartype description: str - :ivar confidence_score: Confidence score for this inference. - :vartype confidence_score: float - :ivar evidence: The evidence corresponding to the inference value. - :vartype evidence: list[~azure.healthinsights.cancerprofiling.models.InferenceEvidence] - :ivar case_id: An identifier for a clinical case, if there are multiple clinical cases - regarding the same patient. - :vartype case_id: str + :ivar value: Numerical value (with implicit precision). + :vartype value: float + :ivar comparator: < | <= | >= | > - how to understand the value. + :vartype comparator: str + :ivar unit: Unit representation. + :vartype unit: str + :ivar system: System that defines coded unit form. + :vartype system: str + :ivar code: Coded form of the unit. + :vartype code: str """ - type: Union[str, "_models.OncoPhenotypeInferenceType"] = rest_field() # pylint: disable=redefined-builtin - """The type of the Onco Phenotype inference. Required. Known values are: \"tumorSite\", \"histology\", - \"clinicalStageT\", \"clinicalStageN\", \"clinicalStageM\", \"pathologicStageT\", \"pathologicStageN\", - and \"pathologicStageM\". """ - value: str = rest_field() - """The value of the inference, as relevant for the given inference type. Required. """ - description: Optional[str] = rest_field() - """The description corresponding to the inference value. """ - confidence_score: Optional[float] = rest_field(name="confidenceScore") - """Confidence score for this inference. """ - evidence: Optional[List["_models.InferenceEvidence"]] = rest_field() - """The evidence corresponding to the inference value. """ - case_id: Optional[str] = rest_field(name="caseId") - """An identifier for a clinical case, if there are multiple clinical cases regarding the same patient. """ + value: Optional[float] = rest_field() + """Numerical value (with implicit precision).""" + comparator: Optional[str] = rest_field() + """< | <= | >= | > - how to understand the value.""" + unit: Optional[str] = rest_field() + """Unit representation.""" + system: Optional[str] = rest_field() + """System that defines coded unit form.""" + code: Optional[str] = rest_field() + """Coded form of the unit.""" @overload def __init__( self, *, - type: Union[str, "_models.OncoPhenotypeInferenceType"], # pylint: disable=redefined-builtin - value: str, - description: Optional[str] = None, - confidence_score: Optional[float] = None, - evidence: Optional[List["_models.InferenceEvidence"]] = None, - case_id: Optional[str] = None, + value: Optional[float] = None, + comparator: Optional[str] = None, + unit: Optional[str] = None, + system: Optional[str] = None, + code: Optional[str] = None, ): ... @@ -386,46 +1339,27 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class OncoPhenotypeModelConfiguration(_model_base.Model): - """Configuration affecting the Onco Phenotype model's inference. +class Range(Element): + """A set of ordered Quantities defined by a low and high limit + Based on `FHIR Range `_. - :ivar verbose: An indication whether the model should produce verbose output. - :vartype verbose: bool - :ivar include_evidence: An indication whether the model's output should include evidence for - the inferences. - :vartype include_evidence: bool - :ivar inference_types: A list of inference types to be inferred for the current request. - This could be used if only part of the Onco Phenotype inferences are required. - If this list is omitted or empty, the model will return all the inference types. - :vartype inference_types: list[str or - ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceType] - :ivar check_for_cancer_case: An indication whether to perform a preliminary step on the - patient's documents to determine whether they relate to a Cancer case. - :vartype check_for_cancer_case: bool + :ivar low: Low limit. + :vartype low: ~azure.healthinsights.cancerprofiling.models.Quantity + :ivar high: High limit. + :vartype high: ~azure.healthinsights.cancerprofiling.models.Quantity """ - verbose: bool = rest_field(default=False) - """An indication whether the model should produce verbose output. """ - include_evidence: bool = rest_field(name="includeEvidence", default=True) - """An indication whether the model's output should include evidence for the inferences. """ - inference_types: Optional[List[Union[str, "_models.OncoPhenotypeInferenceType"]]] = rest_field( - name="inferenceTypes" - ) - """A list of inference types to be inferred for the current request. -This could be used if only part of the Onco Phenotype inferences are required. -If this list is omitted or empty, the model will return all the inference types. """ - check_for_cancer_case: bool = rest_field(name="checkForCancerCase", default=False) - """An indication whether to perform a preliminary step on the patient's documents to determine whether they - relate to a Cancer case. """ + low: Optional["_models.Quantity"] = rest_field() + """Low limit.""" + high: Optional["_models.Quantity"] = rest_field() + """High limit.""" @overload def __init__( self, *, - verbose: bool = False, - include_evidence: bool = True, - inference_types: Optional[List[Union[str, "_models.OncoPhenotypeInferenceType"]]] = None, - check_for_cancer_case: bool = False, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, ): ... @@ -440,28 +1374,27 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class OncoPhenotypePatientResult(_model_base.Model): - """The results of the model's work for a single patient. - - All required parameters must be populated in order to send to Azure. +class Ratio(Element): + """A ratio of two Quantity values - a numerator and a denominator + Based on `FHIR Ratio `_. - :ivar id: The identifier given for the patient in the request. Required. - :vartype id: str - :ivar inferences: The model's inferences for the given patient. Required. - :vartype inferences: list[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInference] + :ivar numerator: Numerator value. + :vartype numerator: ~azure.healthinsights.cancerprofiling.models.Quantity + :ivar denominator: Denominator value. + :vartype denominator: ~azure.healthinsights.cancerprofiling.models.Quantity """ - id: str = rest_field() - """The identifier given for the patient in the request. Required. """ - inferences: List["_models.OncoPhenotypeInference"] = rest_field() - """The model's inferences for the given patient. Required. """ + numerator: Optional["_models.Quantity"] = rest_field() + """Numerator value.""" + denominator: Optional["_models.Quantity"] = rest_field() + """Denominator value.""" @overload def __init__( self, *, - id: str, # pylint: disable=redefined-builtin - inferences: List["_models.OncoPhenotypeInference"], + numerator: Optional["_models.Quantity"] = None, + denominator: Optional["_models.Quantity"] = None, ): ... @@ -476,73 +1409,37 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class OncoPhenotypeResult(_model_base.Model): - """The response for the Onco Phenotype request. - - Readonly variables are only populated by the server, and will be ignored when sending a request. - - All required parameters must be populated in order to send to Azure. - - :ivar job_id: A processing job identifier. Required. - :vartype job_id: str - :ivar created_date_time: The date and time when the processing job was created. Required. - :vartype created_date_time: ~datetime.datetime - :ivar expiration_date_time: The date and time when the processing job is set to expire. - Required. - :vartype expiration_date_time: ~datetime.datetime - :ivar last_update_date_time: The date and time when the processing job was last updated. - Required. - :vartype last_update_date_time: ~datetime.datetime - :ivar status: The status of the processing job. Required. Known values are: "notStarted", - "running", "succeeded", "failed", and "partiallyCompleted". - :vartype status: str or ~azure.healthinsights.cancerprofiling.models.JobStatus - :ivar errors: An array of errors, if any errors occurred during the processing job. - :vartype errors: list[~azure.healthinsights.cancerprofiling.models.Error] - :ivar results: The inference results for the Onco Phenotype request. - :vartype results: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResults - """ - - job_id: str = rest_field(name="jobId", readonly=True) - """A processing job identifier. Required. """ - created_date_time: datetime.datetime = rest_field(name="createdDateTime", readonly=True) - """The date and time when the processing job was created. Required. """ - expiration_date_time: datetime.datetime = rest_field(name="expirationDateTime", readonly=True) - """The date and time when the processing job is set to expire. Required. """ - last_update_date_time: datetime.datetime = rest_field(name="lastUpdateDateTime", readonly=True) - """The date and time when the processing job was last updated. Required. """ - status: Union[str, "_models.JobStatus"] = rest_field(readonly=True) - """The status of the processing job. Required. Known values are: \"notStarted\", \"running\", \"succeeded\", - \"failed\", and \"partiallyCompleted\". """ - errors: Optional[List["_models.Error"]] = rest_field(readonly=True) - """An array of errors, if any errors occurred during the processing job. """ - results: Optional["_models.OncoPhenotypeResults"] = rest_field(readonly=True) - """The inference results for the Onco Phenotype request. """ - - -class OncoPhenotypeResults(_model_base.Model): - """The inference results for the Onco Phenotype request. +class Reference(Element): + """A reference from one resource to another + Based on `FHIR Reference `_. - All required parameters must be populated in order to send to Azure. - - :ivar patients: Results for the patients given in the request. Required. - :vartype patients: - list[~azure.healthinsights.cancerprofiling.models.OncoPhenotypePatientResult] - :ivar model_version: The version of the model used for inference, expressed as the model date. - Required. - :vartype model_version: str + :ivar reference: Literal reference, Relative, internal or absolute URL. + :vartype reference: str + :ivar type: Type the reference refers to (e.g. "Patient"). + :vartype type: str + :ivar identifier: Logical reference, when literal reference is not known. + :vartype identifier: ~azure.healthinsights.cancerprofiling.models.Identifier + :ivar display: Text alternative for the resource. + :vartype display: str """ - patients: List["_models.OncoPhenotypePatientResult"] = rest_field() - """Results for the patients given in the request. Required. """ - model_version: str = rest_field(name="modelVersion") - """The version of the model used for inference, expressed as the model date. Required. """ + reference: Optional[str] = rest_field() + """Literal reference, Relative, internal or absolute URL.""" + type: Optional[str] = rest_field() + """Type the reference refers to (e.g. \"Patient\").""" + identifier: Optional["_models.Identifier"] = rest_field() + """Logical reference, when literal reference is not known.""" + display: Optional[str] = rest_field() + """Text alternative for the resource.""" @overload def __init__( self, *, - patients: List["_models.OncoPhenotypePatientResult"], - model_version: str, + reference: Optional[str] = None, + type: Optional[str] = None, + identifier: Optional["_models.Identifier"] = None, + display: Optional[str] = None, ): ... @@ -557,57 +1454,45 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class PatientDocument(_model_base.Model): - """A clinical document related to a patient. Document here is in the wide sense - not just a text - document (note). +class Resource(_model_base.Model): + """Resource is the ancestor of DomainResource from which most resources are derived. Bundle, + Parameters, and Binary extend Resource directly. + Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. - :ivar type: The type of the patient document, such as 'note' (text document) or 'fhirBundle' - (FHIR JSON document). Required. Known values are: "note", "fhirBundle", "dicom", and - "genomicSequencing". - :vartype type: str or ~azure.healthinsights.cancerprofiling.models.DocumentType - :ivar clinical_type: The type of the clinical document. Known values are: "consultation", - "dischargeSummary", "historyAndPhysical", "procedure", "progress", "imaging", "laboratory", and - "pathology". - :vartype clinical_type: str or - ~azure.healthinsights.cancerprofiling.models.ClinicalDocumentType - :ivar id: A given identifier for the document. Has to be unique across all documents for a - single patient. Required. + :ivar resource_type: The type of resource. Required. + :vartype resource_type: str + :ivar id: Resource Id. :vartype id: str - :ivar language: A 2 letter ISO 639-1 representation of the language of the document. + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.cancerprofiling.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. :vartype language: str - :ivar created_date_time: The date and time when the document was created. - :vartype created_date_time: ~datetime.datetime - :ivar content: The content of the patient document. Required. - :vartype content: ~azure.healthinsights.cancerprofiling.models.DocumentContent """ - type: Union[str, "_models.DocumentType"] = rest_field() # pylint: disable=redefined-builtin - """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document). - Required. Known values are: \"note\", \"fhirBundle\", \"dicom\", and \"genomicSequencing\". """ - clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = rest_field(name="clinicalType") - """The type of the clinical document. Known values are: \"consultation\", \"dischargeSummary\", - \"historyAndPhysical\", \"procedure\", \"progress\", \"imaging\", \"laboratory\", and \"pathology\". """ - id: str = rest_field() - """A given identifier for the document. Has to be unique across all documents for a single patient. Required. """ + resource_type: str = rest_field(name="resourceType") + """The type of resource. Required.""" + id: Optional[str] = rest_field() + """Resource Id.""" + meta: Optional["_models.Meta"] = rest_field() + """Metadata about the resource.""" + implicit_rules: Optional[str] = rest_field(name="implicitRules") + """A set of rules under which this content was created.""" language: Optional[str] = rest_field() - """A 2 letter ISO 639-1 representation of the language of the document. """ - created_date_time: Optional[datetime.datetime] = rest_field(name="createdDateTime") - """The date and time when the document was created. """ - content: "_models.DocumentContent" = rest_field() - """The content of the patient document. Required. """ + """Language of the resource content.""" @overload def __init__( self, *, - type: Union[str, "_models.DocumentType"], # pylint: disable=redefined-builtin - id: str, # pylint: disable=redefined-builtin - content: "_models.DocumentContent", - clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = None, + resource_type: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, language: Optional[str] = None, - created_date_time: Optional[datetime.datetime] = None, ): ... @@ -622,32 +1507,54 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class PatientInfo(_model_base.Model): - """Patient structured information, including demographics and known structured clinical - information. - - :ivar sex: The patient's sex. Known values are: "female", "male", and "unspecified". - :vartype sex: str or ~azure.healthinsights.cancerprofiling.models.PatientInfoSex - :ivar birth_date: The patient's date of birth. - :vartype birth_date: ~datetime.date - :ivar clinical_info: Known clinical information for the patient, structured. - :vartype clinical_info: list[~azure.healthinsights.cancerprofiling.models.ClinicalCodedElement] +class SampledData(Element): + """A series of measurements taken by a device + Based on `FHIR SampledData `_. + + All required parameters must be populated in order to send to server. + + :ivar origin: Zero value and units. Required. + :vartype origin: ~azure.healthinsights.cancerprofiling.models.Quantity + :ivar period: Number of milliseconds between samples. Required. + :vartype period: float + :ivar factor: Multiply data by this before adding to origin. + :vartype factor: float + :ivar lower_limit: Lower limit of detection. + :vartype lower_limit: float + :ivar upper_limit: Upper limit of detection. + :vartype upper_limit: float + :ivar dimensions: Number of sample points at each time point. Required. + :vartype dimensions: int + :ivar data: Decimal values with spaces, or "E" | "U" | "L". + :vartype data: str """ - sex: Optional[Union[str, "_models.PatientInfoSex"]] = rest_field() - """The patient's sex. Known values are: \"female\", \"male\", and \"unspecified\".""" - birth_date: Optional[datetime.date] = rest_field(name="birthDate") - """The patient's date of birth. """ - clinical_info: Optional[List["_models.ClinicalCodedElement"]] = rest_field(name="clinicalInfo") - """Known clinical information for the patient, structured. """ + origin: "_models.Quantity" = rest_field() + """Zero value and units. Required.""" + period: float = rest_field() + """Number of milliseconds between samples. Required.""" + factor: Optional[float] = rest_field() + """Multiply data by this before adding to origin.""" + lower_limit: Optional[float] = rest_field(name="lowerLimit") + """Lower limit of detection.""" + upper_limit: Optional[float] = rest_field(name="upperLimit") + """Upper limit of detection.""" + dimensions: int = rest_field() + """Number of sample points at each time point. Required.""" + data: Optional[str] = rest_field() + """Decimal values with spaces, or \"E\" | \"U\" | \"L\".""" @overload def __init__( self, *, - sex: Optional[Union[str, "_models.PatientInfoSex"]] = None, - birth_date: Optional[datetime.date] = None, - clinical_info: Optional[List["_models.ClinicalCodedElement"]] = None, + origin: "_models.Quantity", + period: float, + dimensions: int, + factor: Optional[float] = None, + lower_limit: Optional[float] = None, + upper_limit: Optional[float] = None, + data: Optional[str] = None, ): ... @@ -662,35 +1569,26 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class PatientRecord(_model_base.Model): - """A patient record, including their clinical information and data. - - All required parameters must be populated in order to send to Azure. +class TimePeriod(_model_base.Model): + """A duration of time during which an event is happening. - :ivar id: A given identifier for the patient. Has to be unique across all patients in a single - request. Required. - :vartype id: str - :ivar info: Patient structured information, including demographics and known structured - clinical information. - :vartype info: ~azure.healthinsights.cancerprofiling.models.PatientInfo - :ivar data: Patient unstructured clinical data, given as documents. - :vartype data: list[~azure.healthinsights.cancerprofiling.models.PatientDocument] + :ivar start: Starting time with inclusive boundary. + :vartype start: ~datetime.datetime + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: ~datetime.datetime """ - id: str = rest_field() - """A given identifier for the patient. Has to be unique across all patients in a single request. Required. """ - info: Optional["_models.PatientInfo"] = rest_field() - """Patient structured information, including demographics and known structured clinical information. """ - data: Optional[List["_models.PatientDocument"]] = rest_field() - """Patient unstructured clinical data, given as documents. """ + start: Optional[datetime.datetime] = rest_field(format="rfc3339") + """Starting time with inclusive boundary.""" + end: Optional[datetime.datetime] = rest_field(format="rfc3339") + """End time with inclusive boundary, if not ongoing.""" @overload def __init__( self, *, - id: str, # pylint: disable=redefined-builtin - info: Optional["_models.PatientInfo"] = None, - data: Optional[List["_models.PatientDocument"]] = None, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, ): ... diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/async_samples/sample_infer_cancer_profiling_async.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/async_samples/sample_infer_cancer_profiling_async.py index c8724d108f717..e18cb52796e71 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/async_samples/sample_infer_cancer_profiling_async.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/async_samples/sample_infer_cancer_profiling_async.py @@ -37,8 +37,7 @@ async def infer_cancer_profiling_async(self) -> None: # Create an Onco Phenotype client # - cancer_profiling_client = CancerProfilingClient(endpoint=ENDPOINT, - credential=AzureKeyCredential(KEY)) + cancer_profiling_client = CancerProfilingClient(endpoint=ENDPOINT, credential=AzureKeyCredential(KEY)) # # Construct patient @@ -70,14 +69,14 @@ async def infer_cancer_profiling_async(self) -> None: Findings are suggestive of a working diagnosis of pneumonia. The patient is referred to a follow-up CXR in 2 weeks.""" - patient_document1 = models.PatientDocument(type=models.DocumentType.NOTE, - id="doc1", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=doc_content1), - clinical_type=models.ClinicalDocumentType.IMAGING, - language="en", - created_date_time=datetime.datetime(2021, 8, 15)) + patient_document1 = models.PatientDocument( + type=models.DocumentType.NOTE, + id="doc1", + content=models.DocumentContent(source_type=models.DocumentContentSourceType.INLINE, value=doc_content1), + clinical_type=models.ClinicalDocumentType.IMAGING, + language="en", + created_date_time=datetime.datetime(2021, 8, 15), + ) doc_content2 = """ Oncology Clinic @@ -107,14 +106,14 @@ async def infer_cancer_profiling_async(self) -> None: Could benefit from biological therapy. Different treatment options were explained- the patient wants to get a second opinion.""" - patient_document2 = models.PatientDocument(type=models.DocumentType.NOTE, - id="doc2", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=doc_content2), - clinical_type=models.ClinicalDocumentType.PATHOLOGY, - language="en", - created_date_time=datetime.datetime(2021, 10, 20)) + patient_document2 = models.PatientDocument( + type=models.DocumentType.NOTE, + id="doc2", + content=models.DocumentContent(source_type=models.DocumentContentSourceType.INLINE, value=doc_content2), + clinical_type=models.ClinicalDocumentType.PATHOLOGY, + language="en", + created_date_time=datetime.datetime(2021, 10, 20), + ) doc_content3 = """ PATHOLOGY REPORT @@ -138,14 +137,14 @@ async def infer_cancer_profiling_async(self) -> None: Blocks with invasive carcinoma: A1 Special studies: Pending""" - patient_document3 = models.PatientDocument(type=models.DocumentType.NOTE, - id="doc3", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=doc_content3), - clinical_type=models.ClinicalDocumentType.PATHOLOGY, - language="en", - created_date_time=datetime.datetime(2022, 1, 1)) + patient_document3 = models.PatientDocument( + type=models.DocumentType.NOTE, + id="doc3", + content=models.DocumentContent(source_type=models.DocumentContentSourceType.INLINE, value=doc_content3), + clinical_type=models.ClinicalDocumentType.PATHOLOGY, + language="en", + created_date_time=datetime.datetime(2022, 1, 1), + ) patient_doc_list = [patient_document1, patient_document2, patient_document3] patient1.data = patient_doc_list @@ -176,12 +175,14 @@ def print_inferences(cancer_profiling_result): for inference in patient_result.inferences: print( f"\n=== Clinical Type: {str(inference.type)} Value: {inference.value}\ - ConfidenceScore: {inference.confidence_score} ===") + ConfidenceScore: {inference.confidence_score} ===" + ) for evidence in inference.evidence: data_evidence = evidence.patient_data_evidence print( f"Evidence {data_evidence.id} {data_evidence.offset} {data_evidence.length}\ - {data_evidence.text}") + {data_evidence.text}" + ) else: errors = cancer_profiling_result.errors if errors is not None: diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/sample_infer_cancer_profiling.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/sample_infer_cancer_profiling.py index 27c38ade59067..83e7f0b8deb50 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/sample_infer_cancer_profiling.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/sample_infer_cancer_profiling.py @@ -67,14 +67,14 @@ def infer_cancer_profiling(self) -> None: Findings are suggestive of a working diagnosis of pneumonia. The patient is referred to a follow-up CXR in 2 weeks.""" - patient_document1 = models.PatientDocument(type=models.DocumentType.NOTE, - id="doc1", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=doc_content1), - clinical_type=models.ClinicalDocumentType.IMAGING, - language="en", - created_date_time=datetime.datetime(2021, 8, 15)) + patient_document1 = models.PatientDocument( + type=models.DocumentType.NOTE, + id="doc1", + content=models.DocumentContent(source_type=models.DocumentContentSourceType.INLINE, value=doc_content1), + clinical_type=models.ClinicalDocumentType.IMAGING, + language="en", + created_date_time=datetime.datetime(2021, 8, 15), + ) doc_content2 = """ Oncology Clinic @@ -104,14 +104,14 @@ def infer_cancer_profiling(self) -> None: Could benefit from biological therapy. Different treatment options were explained- the patient wants to get a second opinion.""" - patient_document2 = models.PatientDocument(type=models.DocumentType.NOTE, - id="doc2", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=doc_content2), - clinical_type=models.ClinicalDocumentType.PATHOLOGY, - language="en", - created_date_time=datetime.datetime(2021, 10, 20)) + patient_document2 = models.PatientDocument( + type=models.DocumentType.NOTE, + id="doc2", + content=models.DocumentContent(source_type=models.DocumentContentSourceType.INLINE, value=doc_content2), + clinical_type=models.ClinicalDocumentType.PATHOLOGY, + language="en", + created_date_time=datetime.datetime(2021, 10, 20), + ) doc_content3 = """ PATHOLOGY REPORT @@ -135,14 +135,14 @@ def infer_cancer_profiling(self) -> None: Blocks with invasive carcinoma: A1 Special studies: Pending""" - patient_document3 = models.PatientDocument(type=models.DocumentType.NOTE, - id="doc3", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=doc_content3), - clinical_type=models.ClinicalDocumentType.PATHOLOGY, - language="en", - created_date_time=datetime.datetime(2022, 1, 1)) + patient_document3 = models.PatientDocument( + type=models.DocumentType.NOTE, + id="doc3", + content=models.DocumentContent(source_type=models.DocumentContentSourceType.INLINE, value=doc_content3), + clinical_type=models.ClinicalDocumentType.PATHOLOGY, + language="en", + created_date_time=datetime.datetime(2022, 1, 1), + ) patient_doc_list = [patient_document1, patient_document2, patient_document3] patient1.data = patient_doc_list diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/setup.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/setup.py index 661aee6d571a5..8f3652af0ca77 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/setup.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/setup.py @@ -13,7 +13,7 @@ PACKAGE_NAME = "azure-healthinsights-cancerprofiling" -PACKAGE_PPRINT_NAME = "Cognitive Services Health Insights Cancer Profilings" +PACKAGE_PPRINT_NAME = "Azure Health Insights - Cancer Profiling" # a-b-c => a/b/c package_folder_path = PACKAGE_NAME.replace("-", "/") @@ -29,7 +29,7 @@ setup( name=PACKAGE_NAME, version=version, - description='Microsoft {} Client Library for Python'.format(PACKAGE_PPRINT_NAME), + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), long_description=open("README.md", "r").read(), long_description_content_type="text/markdown", license="MIT License", @@ -42,11 +42,11 @@ "Programming Language :: Python", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "License :: OSI Approved :: MIT License", ], zip_safe=False, @@ -60,12 +60,11 @@ ), include_package_data=True, package_data={ - "pytyped": ["py.typed"], + "azure.healthinsights.cancerprofiling": ["py.typed"], }, install_requires=[ "isodate<1.0.0,>=0.6.1", - "azure-core<2.0.0,>=1.24.0", - "typing-extensions>=4.3.0; python_version<'3.8.0'", + "azure-core<2.0.0,>=1.29.5", ], - python_requires=">=3.7", + python_requires=">=3.8", ) diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/conftest.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/conftest.py index ce09206dd2994..1c59fd964e908 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/conftest.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/conftest.py @@ -47,6 +47,4 @@ def add_sanitizers(test_proxy): add_general_regex_sanitizer( regex=healthinsights_endpoint, value="https://fake_ad_resource.cognitiveservices.azure.com/" ) - add_general_regex_sanitizer( - regex=healthinsights_key, value="00000000000000000000000000000000" - ) + add_general_regex_sanitizer(regex=healthinsights_key, value="00000000000000000000000000000000") diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/test_cancer_profiling.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/test_cancer_profiling.py index 27aefb6357e10..72aaebee98685 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/test_cancer_profiling.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/test_cancer_profiling.py @@ -20,7 +20,6 @@ class TestCancerProfiling(AzureRecordedTestCase): - @HealthInsightsEnvPreparer() @recorded_by_proxy def test_cancer_profiling(self, healthinsights_endpoint, healthinsights_key): @@ -29,34 +28,28 @@ def test_cancer_profiling(self, healthinsights_endpoint, healthinsights_key): assert cancer_profiling_client is not None data = { - "configuration": { - "checkForCancerCase": True, - "verbose": False, - "includeEvidence": True - }, - "patients": [ - { - "id": "patient1", - "data": [ + "configuration": {"checkForCancerCase": True, "verbose": False, "includeEvidence": True}, + "patients": [ { - "kind": "note", - "clinicalType": "pathology", - "id": "document1", - "language": "en", - "createdDateTime": "2022-01-01T00:00:00", - "content": { - "sourceType": "inline", - "value": "Laterality: Left \n Tumor type present: Invasive duct carcinoma; duct carcinoma in situ \n Tumor site: Upper inner quadrant \n Invasive carcinoma \n Histologic type: Ductal \n Size of invasive component: 0.9 cm \n Histologic Grade - Nottingham combined histologic score: 1 out of 3 \n In situ carcinoma (DCIS) \n Histologic type of DCIS: Cribriform and solid \n Necrosis in DCIS: Yes \n DCIS component of invasive carcinoma: Extensive \n" - } + "id": "patient1", + "data": [ + { + "kind": "note", + "clinicalType": "pathology", + "id": "document1", + "language": "en", + "createdDateTime": "2022-01-01T00:00:00", + "content": { + "sourceType": "inline", + "value": "Laterality: Left \n Tumor type present: Invasive duct carcinoma; duct carcinoma in situ \n Tumor site: Upper inner quadrant \n Invasive carcinoma \n Histologic type: Ductal \n Size of invasive component: 0.9 cm \n Histologic Grade - Nottingham combined histologic score: 1 out of 3 \n In situ carcinoma (DCIS) \n Histologic type of DCIS: Cribriform and solid \n Necrosis in DCIS: Yes \n DCIS component of invasive carcinoma: Extensive \n", + }, + } + ], } - ] - } - ] + ], } poller = cancer_profiling_client.begin_infer_cancer_profile(data) results = poller.result() assert len(results.results.patients[0].inferences) is not 0 - - diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/tsp-location.yaml b/sdk/healthinsights/azure-healthinsights-cancerprofiling/tsp-location.yaml new file mode 100644 index 0000000000000..487f967a12fd0 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/tsp-location.yaml @@ -0,0 +1,7 @@ +additionalDirectories: +- specification/ai/HealthInsights/HealthInsights.Common/ +- specification/ai/HealthInsights/HealthInsights.OpenAPI/ +commit: f3dcae0fb8ccf9267fa0c8eb32f52125c58cd0fd +repo: Azure/azure-rest-api-specs +directory: specification/ai/HealthInsights/HealthInsights.OncoPhenotype + diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/_meta.json b/sdk/healthinsights/azure-healthinsights-clinicalmatching/_meta.json new file mode 100644 index 0000000000000..bb0de43079593 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "f3dcae0fb8ccf9267fa0c8eb32f52125c58cd0fd", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/ai/HealthInsights/HealthInsights.TrialMatcher", + "@azure-tools/typespec-python": "0.18.3" +} \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_client.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_client.py index ae3c44691fb88..3aa3ce5d4c596 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_client.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_client.py @@ -11,6 +11,7 @@ from azure.core import PipelineClient from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies from azure.core.rest import HttpRequest, HttpResponse from ._configuration import ClinicalMatchingClientConfiguration @@ -29,7 +30,7 @@ class ClinicalMatchingClient( :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str :keyword int polling_interval: Default waiting time between two polls for LRO operations if no @@ -37,15 +38,32 @@ class ClinicalMatchingClient( """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - _endpoint = "{endpoint}/healthinsights" + _endpoint = "{endpoint}/health-insights" self._config = ClinicalMatchingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - self._client: PipelineClient = PipelineClient(base_url=_endpoint, config=self._config, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) self._serialize = Serializer() self._deserialize = Deserializer() self._serialize.client_side_validation = False - def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -69,7 +87,7 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore def close(self) -> None: self._client.close() diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_configuration.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_configuration.py index d0c367f193a9d..21622ce1ab5cd 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_configuration.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_configuration.py @@ -6,22 +6,15 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import sys from typing import Any -from azure.core.configuration import Configuration from azure.core.credentials import AzureKeyCredential from azure.core.pipeline import policies from ._version import VERSION -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - -class ClinicalMatchingClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes +class ClinicalMatchingClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long """Configuration for ClinicalMatchingClient. Note that all parameters used to create this instance are saved as instance @@ -33,14 +26,13 @@ class ClinicalMatchingClientConfiguration(Configuration): # pylint: disable=too :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - super(ClinicalMatchingClientConfiguration, self).__init__(**kwargs) - api_version: Literal["2023-03-01-preview"] = kwargs.pop("api_version", "2023-03-01-preview") + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -51,6 +43,7 @@ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) self.credential = credential self.api_version = api_version kwargs.setdefault("sdk_moniker", "healthinsights-clinicalmatching/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _configure(self, **kwargs: Any) -> None: @@ -59,9 +52,9 @@ def _configure(self, **kwargs: Any) -> None: self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) - self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) self.authentication_policy = kwargs.get("authentication_policy") if self.credential and not self.authentication_policy: self.authentication_policy = policies.AzureKeyCredentialPolicy( diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_model_base.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_model_base.py index cedbc25ec4df8..585ccb0e0f90a 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_model_base.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_model_base.py @@ -7,6 +7,8 @@ # pylint: disable=protected-access, arguments-differ, signature-differs, broad-except # pyright: reportGeneralTypeIssues=false +import calendar +import decimal import functools import sys import logging @@ -14,13 +16,14 @@ import re import copy import typing +import email from datetime import datetime, date, time, timedelta, timezone from json import JSONEncoder import isodate from azure.core.exceptions import DeserializationError from azure.core import CaseInsensitiveEnumMeta from azure.core.pipeline import PipelineResponse -from azure.core.serialization import NULL as AzureCoreNull +from azure.core.serialization import _Null if sys.version_info >= (3, 9): from collections.abc import MutableMapping @@ -29,23 +32,7 @@ _LOGGER = logging.getLogger(__name__) -__all__ = ["NULL", "AzureJSONEncoder", "Model", "rest_field", "rest_discriminator"] - - -class _Null(object): - """To create a Falsy object""" - - def __bool__(self): - return False - - __nonzero__ = __bool__ # Python2 compatibility - - -NULL = _Null() -""" -A falsy sentinel object which is supposed to be used to specify attributes -with no data. This gets serialized to `null` on the wire. -""" +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] TZ_UTC = timezone.utc @@ -74,69 +61,53 @@ def _timedelta_as_isostr(td: timedelta) -> str: if days: date_str = "%sD" % days - # Build time - time_str = "T" + if hours or minutes or seconds: + # Build time + time_str = "T" - # Hours - bigger_exists = date_str or hours - if bigger_exists: - time_str += "{:02}H".format(hours) + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) - # Minutes - bigger_exists = bigger_exists or minutes - if bigger_exists: - time_str += "{:02}M".format(minutes) + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) - # Seconds - try: - if seconds.is_integer(): - seconds_string = "{:02}".format(int(seconds)) - else: - # 9 chars long w/ leading 0, 6 digits after decimal - seconds_string = "%09.6f" % seconds - # Remove trailing zeros - seconds_string = seconds_string.rstrip("0") - except AttributeError: # int.is_integer() raises - seconds_string = "{:02}".format(seconds) + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) - time_str += "{}S".format(seconds_string) + time_str += "{}S".format(seconds_string) + else: + time_str = "" return "P" + date_str + time_str -def _datetime_as_isostr(dt: typing.Union[datetime, date, time, timedelta]) -> str: - """Converts a datetime.(datetime|date|time|timedelta) object into an ISO 8601 formatted string - - :param timedelta dt: The date object to convert - :rtype: str - :return: ISO8601 version of this datetime - """ - # First try datetime.datetime - if hasattr(dt, "year") and hasattr(dt, "hour"): - dt = typing.cast(datetime, dt) - # astimezone() fails for naive times in Python 2.7, so make make sure dt is aware (tzinfo is set) - if not dt.tzinfo: - iso_formatted = dt.replace(tzinfo=TZ_UTC).isoformat() - else: - iso_formatted = dt.astimezone(TZ_UTC).isoformat() - # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) - return iso_formatted.replace("+00:00", "Z") - # Next try datetime.date or datetime.time - try: - dt = typing.cast(typing.Union[date, time], dt) - return dt.isoformat() - # Last, try datetime.timedelta - except AttributeError: - dt = typing.cast(timedelta, dt) - return _timedelta_as_isostr(dt) - - -def _serialize_bytes(o) -> str: - return base64.b64encode(o).decode() +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded -def _serialize_datetime(o): +def _serialize_datetime(o, format: typing.Optional[str] = None): if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) if not o.tzinfo: iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() @@ -150,32 +121,37 @@ def _serialize_datetime(o): def _is_readonly(p): try: - return p._readonly # pylint: disable=protected-access + return p._visibility == ["read"] # pylint: disable=protected-access except AttributeError: return False -class AzureJSONEncoder(JSONEncoder): +class SdkJSONEncoder(JSONEncoder): """A JSON encoder that's capable of serializing datetime objects and bytes.""" + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + def default(self, o): # pylint: disable=too-many-return-statements if _is_model(o): - readonly_props = [ - p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p) - ] # pylint: disable=protected-access - return {k: v for k, v in o.items() if k not in readonly_props} - if isinstance(o, (bytes, bytearray)): - return base64.b64encode(o).decode() - if o is AzureCoreNull: - return None + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) try: - return super(AzureJSONEncoder, self).default(o) + return super(SdkJSONEncoder, self).default(o) except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) if isinstance(o, (bytes, bytearray)): - return _serialize_bytes(o) + return _serialize_bytes(o, self.format) try: # First try datetime.datetime - return _serialize_datetime(o) + return _serialize_datetime(o, self.format) except AttributeError: pass # Last, try datetime.timedelta @@ -184,10 +160,14 @@ def default(self, o): # pylint: disable=too-many-return-statements except AttributeError: # This will be raised when it hits value.total_seconds in the method above pass - return super(AzureJSONEncoder, self).default(o) + return super(SdkJSONEncoder, self).default(o) _VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: @@ -223,6 +203,36 @@ def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: return date_obj +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + def _deserialize_date(attr: typing.Union[str, date]) -> date: """Deserialize ISO-8601 formatted string into Date object. :param str attr: response string to be deserialized. @@ -247,33 +257,74 @@ def _deserialize_time(attr: typing.Union[str, time]) -> time: return isodate.parse_time(attr) -def deserialize_bytes(attr): +def _deserialize_bytes(attr): if isinstance(attr, (bytes, bytearray)): return attr return bytes(base64.b64decode(attr)) -def deserialize_duration(attr): +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): if isinstance(attr, timedelta): return attr return isodate.parse_duration(attr) +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + _DESERIALIZE_MAPPING = { datetime: _deserialize_datetime, date: _deserialize_date, time: _deserialize_time, - bytes: deserialize_bytes, - timedelta: deserialize_duration, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, } +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + def _get_model(module_name: str, model_name: str): models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} module_end = module_name.rsplit(".", 1)[0] - module = sys.modules[module_end] - models.update({k: v for k, v in module.__dict__.items() if isinstance(v, type)}) + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) if isinstance(model_name, str): model_name = model_name.split(".")[-1] if model_name not in models: @@ -374,12 +425,22 @@ def _is_model(obj: typing.Any) -> bool: return getattr(obj, "_is_model", False) -def _serialize(o): +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) if isinstance(o, (bytes, bytearray)): - return _serialize_bytes(o) + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) try: # First try datetime.datetime - return _serialize_datetime(o) + return _serialize_datetime(o, format) except AttributeError: pass # Last, try datetime.timedelta @@ -401,7 +462,7 @@ def _get_rest_field( def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: - return _deserialize(rf._type, value) if (rf and rf._is_model) else _serialize(value) + return _deserialize(rf._type, value) if (rf and rf._is_model) else _serialize(value, rf._format if rf else None) class Model(_MyMutableMapping): @@ -425,7 +486,13 @@ def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: if non_attr_kwargs: # actual type errors only throw the first wrong keyword arg they see, so following that. raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") - dict_to_pass.update({self._attr_to_rest_field[k]._rest_name: _serialize(v) for k, v in kwargs.items()}) + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) super().__init__(dict_to_pass) def copy(self) -> "Model": @@ -459,31 +526,77 @@ def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member @classmethod - def _get_discriminator(cls) -> typing.Optional[str]: + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: for v in cls.__dict__.values(): - if isinstance(v, _RestField) and v._is_discriminator: # pylint: disable=protected-access + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access return v._rest_name # pylint: disable=protected-access return None @classmethod - def _deserialize(cls, data): + def _deserialize(cls, data, exist_discriminators): if not hasattr(cls, "__mapping__"): # pylint: disable=no-member return cls(data) - discriminator = cls._get_discriminator() + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pylint: disable=no-member if mapped_cls == cls: return cls(data) - return mapped_cls._deserialize(data) # pylint: disable=protected-access + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore[reportUnboundVariable] + continue + result[k] = Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return [Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v] + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v -def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-return-statements, too-many-statements - annotation: typing.Any, module: typing.Optional[str], rf: typing.Optional["_RestField"] = None +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: if not annotation or annotation in [int, float]: return None + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + try: - if module and _is_model(_get_model(module, annotation)): + if module and _is_model(annotation): if rf: rf._is_model = True @@ -492,40 +605,20 @@ def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj return obj return _deserialize(model_deserializer, obj) - return functools.partial(_deserialize_model, _get_model(module, annotation)) + return functools.partial(_deserialize_model, annotation) except Exception: pass # is it a literal? try: - if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports - else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - - if annotation.__origin__ == Literal: + if annotation.__origin__ is typing.Literal: return None except AttributeError: pass - if getattr(annotation, "__origin__", None) is typing.Union: - - def _deserialize_with_union(union_annotation, obj): - for t in union_annotation.__args__: - try: - return _deserialize(t, obj, module) - except DeserializationError: - pass - raise DeserializationError() - - return functools.partial(_deserialize_with_union, annotation) - # is it optional? try: - # right now, assuming we don't have unions, since we're getting rid of the only - # union we used to have in msrest models, which was union of str and enum if any(a for a in annotation.__args__ if a == type(None)): - if_obj_deserializer = _get_deserialize_callable_from_annotation( next(a for a in annotation.__args__ if a != type(None)), module, rf ) @@ -539,35 +632,33 @@ def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Calla except AttributeError: pass - # is it a forward ref / in quotes? - if isinstance(annotation, (str, typing.ForwardRef)): - try: - model_name = annotation.__forward_arg__ # type: ignore - except AttributeError: - model_name = annotation - if module is not None: - annotation = _get_model(module, model_name) + if getattr(annotation, "__origin__", None) is typing.Union: + deserializers = [_get_deserialize_callable_from_annotation(arg, module, rf) for arg in annotation.__args__] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) try: if annotation._name == "Dict": - key_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) value_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[1], module, rf) def _deserialize_dict( - key_deserializer: typing.Optional[typing.Callable], value_deserializer: typing.Optional[typing.Callable], obj: typing.Dict[typing.Any, typing.Any], ): if obj is None: return obj - return { - _deserialize(key_deserializer, k, module): _deserialize(value_deserializer, v, module) - for k, v in obj.items() - } + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} return functools.partial( _deserialize_dict, - key_deserializer, value_deserializer, ) except (AttributeError, IndexError): @@ -577,7 +668,8 @@ def _deserialize_dict( if len(annotation.__args__) > 1: def _deserialize_multiple_sequence( - entry_deserializers: typing.List[typing.Optional[typing.Callable]], obj + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, ): if obj is None: return obj @@ -605,26 +697,29 @@ def _deserialize_sequence( pass def _deserialize_default( - annotation, - deserializer_from_mapping, + deserializer, obj, ): if obj is None: return obj try: - return _deserialize_with_callable(annotation, obj) + return _deserialize_with_callable(deserializer, obj) except Exception: pass - return _deserialize_with_callable(deserializer_from_mapping, obj) + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) - return functools.partial(_deserialize_default, annotation, _DESERIALIZE_MAPPING.get(annotation)) + return functools.partial(_deserialize_default, annotation) def _deserialize_with_callable( - deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], value: typing.Any + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, ): try: - if value is None: + if value is None or isinstance(value, _Null): return None if deserializer is None: return value @@ -635,16 +730,25 @@ def _deserialize_with_callable( # for unknown value, return raw value return value if isinstance(deserializer, type) and issubclass(deserializer, Model): - return deserializer._deserialize(value) # type: ignore + return deserializer._deserialize(value, []) return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) except Exception as e: raise DeserializationError() from e -def _deserialize(deserializer: typing.Any, value: typing.Any, module: typing.Optional[str] = None) -> typing.Any: +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: if isinstance(value, PipelineResponse): value = value.http_response.json() - deserializer = _get_deserialize_callable_from_annotation(deserializer, module) + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) return _deserialize_with_callable(deserializer, value) @@ -653,18 +757,20 @@ def __init__( self, *, name: typing.Optional[str] = None, - type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin is_discriminator: bool = False, - readonly: bool = False, + visibility: typing.Optional[typing.List[str]] = None, default: typing.Any = _UNSET, + format: typing.Optional[str] = None, ): self._type = type self._rest_name_input = name self._module: typing.Optional[str] = None self._is_discriminator = is_discriminator - self._readonly = readonly + self._visibility = visibility self._is_model = False self._default = default + self._format = format @property def _rest_name(self) -> str: @@ -672,13 +778,15 @@ def _rest_name(self) -> str: raise ValueError("Rest name was never set") return self._rest_name_input - def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin # by this point, type and rest_name will have a value bc we default # them in __new__ of the Model class item = obj.get(self._rest_name) if item is None: return item - return _deserialize(self._type, _serialize(item)) + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) def __set__(self, obj: Model, value) -> None: if value is None: @@ -688,9 +796,12 @@ def __set__(self, obj: Model, value) -> None: except KeyError: pass return - if self._is_model and not _is_model(value): - obj.__setitem__(self._rest_name, _deserialize(self._type, value)) - obj.__setitem__(self._rest_name, _serialize(value)) + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) def _get_deserialize_callable_from_annotation( self, annotation: typing.Any @@ -701,14 +812,17 @@ def _get_deserialize_callable_from_annotation( def rest_field( *, name: typing.Optional[str] = None, - type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin - readonly: bool = False, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, default: typing.Any = _UNSET, + format: typing.Optional[str] = None, ) -> typing.Any: - return _RestField(name=name, type=type, readonly=readonly, default=default) + return _RestField(name=name, type=type, visibility=visibility, default=default, format=format) def rest_discriminator( - *, name: typing.Optional[str] = None, type: typing.Optional[typing.Callable] = None # pylint: disable=redefined-builtin + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin ) -> typing.Any: return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_operations/_operations.py index c9a1afa2a1900..0f37c999fc247 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_operations/_operations.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_operations/_operations.py @@ -1,4 +1,4 @@ -# pylint: disable=too-many-lines +# pylint: disable=too-many-lines,too-many-statements # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -7,9 +7,11 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- import datetime +from io import IOBase import json import sys from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload +import uuid from azure.core.exceptions import ( ClientAuthenticationError, @@ -20,15 +22,14 @@ map_error, ) from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import HttpResponse from azure.core.polling import LROPoller, NoPolling, PollingMethod from azure.core.polling.base_polling import LROBasePolling -from azure.core.rest import HttpRequest +from azure.core.rest import HttpRequest, HttpResponse from azure.core.tracing.decorator import distributed_trace from azure.core.utils import case_insensitive_dict from .. import models as _models -from .._model_base import AzureJSONEncoder, _deserialize +from .._model_base import SdkJSONEncoder, _deserialize from .._serialization import Serializer from .._vendor import ClinicalMatchingClientMixinABC @@ -36,10 +37,6 @@ from collections.abc import MutableMapping else: from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] @@ -48,35 +45,26 @@ _SERIALIZER.client_side_validation = False -def build_clinical_matching_match_trials_request( # pylint: disable=name-too-long - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any -) -> HttpRequest: +def build_clinical_matching_match_trials_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: Literal["2023-03-01-preview"] = kwargs.pop( - "api_version", _params.pop("api-version", "2023-03-01-preview") - ) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL - _url = "/trialmatcher/jobs" + _url = "/trial-matcher/jobs" # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers - if repeatability_request_id is not None: - _headers["Repeatability-Request-ID"] = _SERIALIZER.header( - "repeatability_request_id", repeatability_request_id, "str" - ) - if repeatability_first_sent is not None: - _headers["Repeatability-First-Sent"] = _SERIALIZER.header( - "repeatability_first_sent", repeatability_first_sent, "iso-8601" + if "Repeatability-Request-ID" not in _headers: + _headers["Repeatability-Request-ID"] = str(uuid.uuid4()) + if "Repeatability-First-Sent" not in _headers: + _headers["Repeatability-First-Sent"] = _SERIALIZER.serialize_data( + datetime.datetime.now(datetime.timezone.utc), "rfc-1123" ) _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") if content_type is not None: @@ -86,14 +74,7 @@ def build_clinical_matching_match_trials_request( # pylint: disable=name-too-lo class ClinicalMatchingClientOperationsMixin(ClinicalMatchingClientMixinABC): - def _match_trials_initial( - self, - body: Union[_models.TrialMatcherData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> Optional[_models.TrialMatcherResult]: + def _match_trials_initial(self, body: Union[_models.TrialMatcherData, JSON, IO[bytes]], **kwargs: Any) -> JSON: error_map = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, @@ -106,18 +87,16 @@ def _match_trials_initial( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[Optional[_models.TrialMatcherResult]] = kwargs.pop("cls", None) + cls: ClsType[JSON] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None - if isinstance(body, (IO, bytes)): + if isinstance(body, (IOBase, bytes)): _content = body else: - _content = json.dumps(body, cls=AzureJSONEncoder) # type: ignore + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_clinical_matching_match_trials_request( - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, + _request = build_clinical_matching_match_trials_request( content_type=content_type, api_version=self._config.api_version, content=_content, @@ -127,218 +106,12898 @@ def _match_trials_initial( path_format_arguments = { "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [200, 202]: + if response.status_code not in [202]: + if _stream: + response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) - deserialized = None response_headers = {} - if response.status_code == 200: - deserialized = _deserialize(_models.TrialMatcherResult, response.json()) + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) - if response.status_code == 202: - response_headers["Operation-Location"] = self._deserialize( - "str", response.headers.get("Operation-Location") - ) - response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) - response_headers["Repeatability-Result"] = self._deserialize( - "str", response.headers.get("Repeatability-Result") - ) + deserialized = _deserialize(JSON, response.json()) if cls: - return cls(pipeline_response, deserialized, response_headers) + return cls(pipeline_response, deserialized, response_headers) # type: ignore - return deserialized + return deserialized # type: ignore @overload def begin_match_trials( - self, - body: _models.TrialMatcherData, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> LROPoller[_models.TrialMatcherResult]: + self, body: _models.TrialMatcherData, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. :param body: Required. :type body: ~azure.healthinsights.clinicalmatching.models.TrialMatcherData - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns TrialMatcherResult. The TrialMatcherResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", # Default + value is "ResearchStudy". resourceType. Required. + "status": "str", # active | + administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | + in-review | temporarily-closed-to-accrual | + temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", + "administratively-completed", "approved", "closed-to-accrual", + "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", + "temporarily-closed-to-accrual-and-intervention", and + "withdrawn". + "arm": [ + { + "name": "str", # Label for + study arm. Required. + "description": "str", # + Optional. Short explanation of study path. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "category": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "condition": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "contact": [ + { + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "name": "str", # Optional. + Name of an individual to contact. + "telecom": [ + { + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "rank": 0, # + Optional. Specify preferred order of use (1 = + highest). + "system": + "str", # Optional. phone | fax | email | pager | + url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and + "other". + "use": "str", + # Optional. home | work | temp | old | mobile - + purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + "value": + "str" # Optional. The actual contact point + details. + } + ] + } + ], + "contained": [ + { + "resourceType": "str", # The + type of resource. Required. + "id": "str", # Optional. + Resource Id. + "implicitRules": "str", # + Optional. A set of rules under which this content was + created. + "language": "str", # + Optional. Language of the resource content. + "meta": { + "lastUpdated": "str", + # Optional. When the resource last changed - e.g. + when the version changed. + "profile": [ + "str" # + Optional. A list of profiles (references to + `StructureDefinition + `_ + resources) that this resource claims to conform + to. The URL is a reference to + `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "source": "str", # + Optional. A uri that identifies the source system of + the resource. This provides a minimal amount of + Provenance information that can be used to track or + differentiate the source of information in the + resource. The source may identify another FHIR + server, document, message, database, etc. + "tag": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it + appears in the version portion of the URL. This value + changes when the resource is created, updated, or + deleted. + } + } + ], + "description": "str", # Optional. What this + is study doing. + "enrollment": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "focus": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "id": "str", # Optional. Resource Id. + "identifier": [ + { + "assigner": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": ..., + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": ..., + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + } + ], + "implicitRules": "str", # Optional. A set of + rules under which this content was created. + "keyword": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "language": "str", # Optional. Language of + the resource content. + "location": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "meta": { + "lastUpdated": "str", # Optional. + When the resource last changed - e.g. when the version + changed. + "profile": [ + "str" # Optional. A list of + profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. The + URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "source": "str", # Optional. A uri + that identifies the source system of the resource. This + provides a minimal amount of Provenance information that can + be used to track or differentiate the source of information + in the resource. The source may identify another FHIR server, + document, message, database, etc. + "tag": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "versionId": "str" # Optional. The + version specific identifier, as it appears in the version + portion of the URL. This value changes when the resource is + created, updated, or deleted. + }, + "modifierExtension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "note": [ + { + "text": "str", # The + annotation - text content (as markdown). Required. + "authorString": "str", # + Optional. Individual responsible for the annotation. + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "time": "str" # Optional. + When the annotation was made. + } + ], + "objective": [ + { + "name": "str", # Label for + the objective. Required. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "partOf": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "phase": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "primaryPurposeType": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "principalInvestigator": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "protocol": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "reasonStopped": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "site": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "sponsor": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "text": { + "div": "str", # xhtml. Required. + "status": "str", # generated, + extensions, additional, empty. Required. + "extension": [ + { + "url": "str", # + Source of the definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, + # Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "valueDateTime": + "str", # Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": + { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": + "str", # Optional. Text alternative for the + resource. + "identifier": + { + "assigner": ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. The namespace + for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | official | + temp | secondary | old (If known). + "value": "str" # Optional. The value that is + unique. + }, + "reference": + "str", # Optional. Literal reference, Relative, + internal or absolute URL. + "type": "str" + # Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": + 0, # Number of sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": + 0.0, # Number of milliseconds between samples. + Required. + "data": + "str", # Optional. Decimal values with spaces, + or "E" | "U" | "L". + "factor": + 0.0, # Optional. Multiply data by this before + adding to origin. + "lowerLimit": + 0.0, # Optional. Lower limit of detection. + "upperLimit": + 0.0 # Optional. Upper limit of detection. + }, + "valueString": "str", + # Optional. Value as string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str" # Optional. Unique id + for inter-element referencing. + }, + "title": "str" # Optional. Name for this + study. + } + ], + "registryFilters": [ + { + "conditions": [ + "str" # Optional. Trials with any of + the given medical conditions will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the medical + conditions. + ], + "facilityAreas": [ + { + "geometry": { + "coordinates": [ + 0.0 # + Coordinates of the area circle's center, + represented according to the ``GeoJSON`` + standard. This is an array of 2 decimal numbers, + longitude and latitude (precisely in this order). + Required. + ], + "type": "str" # + ``GeoJSON`` geometry type. Required. "Point" + }, + "properties": { + "radius": 0.0, # The + radius of the area's circle, in meters. Required. + "subType": "str" # + ``GeoJSON`` object sub-type. Required. "Circle" + }, + "type": "str" # ``GeoJSON`` + type. Required. "Feature" + } + ], + "facilityLocations": [ + { + "countryOrRegion": "str", # + Country/region name. Required. + "city": "str", # Optional. + City name. + "state": "str" # Optional. + State name. + } + ], + "facilityNames": [ + "str" # Optional. Trials with any of + the given facility names will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial facility names. + ], + "ids": [ + "str" # Optional. Trials with any of + the given identifiers will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial identifiers. + ], + "phases": [ + "str" # Optional. Trials with any of + the given phases will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the phases. + ], + "purposes": [ + "str" # Optional. Trials with any of + the given purposes will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the purposes. + ], + "recruitmentStatuses": [ + "str" # Optional. Trials with any of + the given recruitment statuses will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the recruitment + statuses. + ], + "sources": [ + "str" # Optional. Trials with any of + the given sources will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the sources. + ], + "sponsors": [ + "str" # Optional. Trials with any of + the given sponsors will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the sponsors. + ], + "studyTypes": [ + "str" # Optional. Trials with any of + the given study types will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the study types. + ] + } + ] + }, + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ @overload def begin_match_trials( - self, - body: JSON, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> LROPoller[_models.TrialMatcherResult]: + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. :param body: Required. :type body: JSON - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns TrialMatcherResult. The TrialMatcherResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ @overload def begin_match_trials( - self, - body: IO, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> LROPoller[_models.TrialMatcherResult]: + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. :param body: Required. - :type body: IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime + :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns TrialMatcherResult. The TrialMatcherResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ @distributed_trace def begin_match_trials( - self, - body: Union[_models.TrialMatcherData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> LROPoller[_models.TrialMatcherResult]: + self, body: Union[_models.TrialMatcherData, JSON, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. - :param body: Is one of the following types: TrialMatcherData, JSON, IO Required. - :type body: ~azure.healthinsights.clinicalmatching.models.TrialMatcherData or JSON or IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime + :param body: Is one of the following types: TrialMatcherData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.clinicalmatching.models.TrialMatcherData or JSON or IO[bytes] :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default value is None. :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns TrialMatcherResult. The TrialMatcherResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", # Default + value is "ResearchStudy". resourceType. Required. + "status": "str", # active | + administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | + in-review | temporarily-closed-to-accrual | + temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", + "administratively-completed", "approved", "closed-to-accrual", + "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", + "temporarily-closed-to-accrual-and-intervention", and + "withdrawn". + "arm": [ + { + "name": "str", # Label for + study arm. Required. + "description": "str", # + Optional. Short explanation of study path. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "category": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "condition": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "contact": [ + { + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "name": "str", # Optional. + Name of an individual to contact. + "telecom": [ + { + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "rank": 0, # + Optional. Specify preferred order of use (1 = + highest). + "system": + "str", # Optional. phone | fax | email | pager | + url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and + "other". + "use": "str", + # Optional. home | work | temp | old | mobile - + purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + "value": + "str" # Optional. The actual contact point + details. + } + ] + } + ], + "contained": [ + { + "resourceType": "str", # The + type of resource. Required. + "id": "str", # Optional. + Resource Id. + "implicitRules": "str", # + Optional. A set of rules under which this content was + created. + "language": "str", # + Optional. Language of the resource content. + "meta": { + "lastUpdated": "str", + # Optional. When the resource last changed - e.g. + when the version changed. + "profile": [ + "str" # + Optional. A list of profiles (references to + `StructureDefinition + `_ + resources) that this resource claims to conform + to. The URL is a reference to + `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "source": "str", # + Optional. A uri that identifies the source system of + the resource. This provides a minimal amount of + Provenance information that can be used to track or + differentiate the source of information in the + resource. The source may identify another FHIR + server, document, message, database, etc. + "tag": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it + appears in the version portion of the URL. This value + changes when the resource is created, updated, or + deleted. + } + } + ], + "description": "str", # Optional. What this + is study doing. + "enrollment": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "focus": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "id": "str", # Optional. Resource Id. + "identifier": [ + { + "assigner": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": ..., + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": ..., + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + } + ], + "implicitRules": "str", # Optional. A set of + rules under which this content was created. + "keyword": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "language": "str", # Optional. Language of + the resource content. + "location": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "meta": { + "lastUpdated": "str", # Optional. + When the resource last changed - e.g. when the version + changed. + "profile": [ + "str" # Optional. A list of + profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. The + URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "source": "str", # Optional. A uri + that identifies the source system of the resource. This + provides a minimal amount of Provenance information that can + be used to track or differentiate the source of information + in the resource. The source may identify another FHIR server, + document, message, database, etc. + "tag": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "versionId": "str" # Optional. The + version specific identifier, as it appears in the version + portion of the URL. This value changes when the resource is + created, updated, or deleted. + }, + "modifierExtension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "note": [ + { + "text": "str", # The + annotation - text content (as markdown). Required. + "authorString": "str", # + Optional. Individual responsible for the annotation. + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "time": "str" # Optional. + When the annotation was made. + } + ], + "objective": [ + { + "name": "str", # Label for + the objective. Required. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "partOf": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "phase": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "primaryPurposeType": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "principalInvestigator": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "protocol": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "reasonStopped": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "site": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "sponsor": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "text": { + "div": "str", # xhtml. Required. + "status": "str", # generated, + extensions, additional, empty. Required. + "extension": [ + { + "url": "str", # + Source of the definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, + # Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "valueDateTime": + "str", # Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": + { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": + "str", # Optional. Text alternative for the + resource. + "identifier": + { + "assigner": ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. The namespace + for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | official | + temp | secondary | old (If known). + "value": "str" # Optional. The value that is + unique. + }, + "reference": + "str", # Optional. Literal reference, Relative, + internal or absolute URL. + "type": "str" + # Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": + 0, # Number of sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": + 0.0, # Number of milliseconds between samples. + Required. + "data": + "str", # Optional. Decimal values with spaces, + or "E" | "U" | "L". + "factor": + 0.0, # Optional. Multiply data by this before + adding to origin. + "lowerLimit": + 0.0, # Optional. Lower limit of detection. + "upperLimit": + 0.0 # Optional. Upper limit of detection. + }, + "valueString": "str", + # Optional. Value as string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str" # Optional. Unique id + for inter-element referencing. + }, + "title": "str" # Optional. Name for this + study. + } + ], + "registryFilters": [ + { + "conditions": [ + "str" # Optional. Trials with any of + the given medical conditions will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the medical + conditions. + ], + "facilityAreas": [ + { + "geometry": { + "coordinates": [ + 0.0 # + Coordinates of the area circle's center, + represented according to the ``GeoJSON`` + standard. This is an array of 2 decimal numbers, + longitude and latitude (precisely in this order). + Required. + ], + "type": "str" # + ``GeoJSON`` geometry type. Required. "Point" + }, + "properties": { + "radius": 0.0, # The + radius of the area's circle, in meters. Required. + "subType": "str" # + ``GeoJSON`` object sub-type. Required. "Circle" + }, + "type": "str" # ``GeoJSON`` + type. Required. "Feature" + } + ], + "facilityLocations": [ + { + "countryOrRegion": "str", # + Country/region name. Required. + "city": "str", # Optional. + City name. + "state": "str" # Optional. + State name. + } + ], + "facilityNames": [ + "str" # Optional. Trials with any of + the given facility names will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial facility names. + ], + "ids": [ + "str" # Optional. Trials with any of + the given identifiers will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial identifiers. + ], + "phases": [ + "str" # Optional. Trials with any of + the given phases will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the phases. + ], + "purposes": [ + "str" # Optional. Trials with any of + the given purposes will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the purposes. + ], + "recruitmentStatuses": [ + "str" # Optional. Trials with any of + the given recruitment statuses will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the recruitment + statuses. + ], + "sources": [ + "str" # Optional. Trials with any of + the given sources will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the sources. + ], + "sponsors": [ + "str" # Optional. Trials with any of + the given sponsors will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the sponsors. + ], + "studyTypes": [ + "str" # Optional. Trials with any of + the given study types will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the study types. + ] + } + ] + }, + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[_models.TrialMatcherResult] = kwargs.pop("cls", None) + cls: ClsType[_models.TrialMatcherInferenceResult] = kwargs.pop("cls", None) polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token: Optional[str] = kwargs.pop("continuation_token", None) if cont_token is None: raw_result = self._match_trials_initial( - body=body, - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, - content_type=content_type, - cls=lambda x, y, z: x, - headers=_headers, - params=_params, - **kwargs + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs ) kwargs.pop("error_map", None) def get_long_running_output(pipeline_response): + response_headers = {} response = pipeline_response.http_response - deserialized = _deserialize(_models.TrialMatcherResult, response.json()) + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.TrialMatcherInferenceResult, response.json().get("result")) if cls: - return cls(pipeline_response, deserialized, {}) # type: ignore + return cls(pipeline_response, deserialized, response_headers) # type: ignore return deserialized path_format_arguments = { @@ -354,10 +13013,12 @@ def get_long_running_output(pipeline_response): else: polling_method = polling if cont_token: - return LROPoller.from_continuation_token( + return LROPoller[_models.TrialMatcherInferenceResult].from_continuation_token( polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output, ) - return LROPoller(self._client, raw_result, get_long_running_output, polling_method) # type: ignore + return LROPoller[_models.TrialMatcherInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_serialization.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_serialization.py index f17c068e833e8..baa661cb82d24 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_serialization.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_serialization.py @@ -63,8 +63,8 @@ import isodate # type: ignore -from azure.core.exceptions import DeserializationError, SerializationError, raise_with_traceback -from azure.core.serialization import NULL as AzureCoreNull +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull _BOM = codecs.BOM_UTF8.decode(encoding="utf-8") @@ -124,7 +124,7 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: pass return ET.fromstring(data_as_str) # nosec - except ET.ParseError: + except ET.ParseError as err: # It might be because the server has an issue, and returned JSON with # content-type XML.... # So let's try a JSON load, and if it's still broken @@ -143,7 +143,7 @@ def _json_attemp(data): # The function hack is because Py2.7 messes up with exception # context otherwise. _LOGGER.critical("Wasn't XML not JSON, failing") - raise_with_traceback(DeserializationError, "XML is invalid") + raise DeserializationError("XML is invalid") from err raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) @classmethod @@ -295,7 +295,7 @@ class Model(object): _validation: Dict[str, Dict[str, Any]] = {} def __init__(self, **kwargs: Any) -> None: - self.additional_properties: Dict[str, Any] = {} + self.additional_properties: Optional[Dict[str, Any]] = {} for k in kwargs: if k not in self._attribute_map: _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) @@ -340,7 +340,7 @@ def _create_xml_node(cls): return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: - """Return the JSON that would be sent to azure from this model. + """Return the JSON that would be sent to server from this model. This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. @@ -351,7 +351,7 @@ def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore def as_dict( self, @@ -390,7 +390,7 @@ def my_key_transformer(key, attr_desc, value): :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore @classmethod def _infer_class_models(cls): @@ -415,7 +415,7 @@ def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = N :raises: DeserializationError if something went wrong """ deserializer = Deserializer(cls._infer_class_models()) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def from_dict( @@ -445,7 +445,7 @@ def from_dict( if key_extractors is None else key_extractors ) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def _flatten_subtype(cls, key, objects): @@ -629,7 +629,7 @@ def _serialize(self, target_obj, data_type=None, **kwargs): if xml_desc.get("attr", False): if xml_ns: ET.register_namespace(xml_prefix, xml_ns) - xml_name = "{}{}".format(xml_ns, xml_name) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) serialized.set(xml_name, new_attr) # type: ignore continue if xml_desc.get("text", False): @@ -662,12 +662,13 @@ def _serialize(self, target_obj, data_type=None, **kwargs): _serialized.update(_new_attr) # type: ignore _new_attr = _new_attr[k] # type: ignore _serialized = _serialized[k] - except ValueError: - continue + except ValueError as err: + if isinstance(err, SerializationError): + raise except (AttributeError, KeyError, TypeError) as err: msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) - raise_with_traceback(SerializationError, msg, err) + raise SerializationError(msg) from err else: return serialized @@ -709,7 +710,7 @@ def body(self, data, data_type, **kwargs): ] data = deserializer._deserialize(data_type, data) except DeserializationError as err: - raise_with_traceback(SerializationError, "Unable to build a model: " + str(err), err) + raise SerializationError("Unable to build a model: " + str(err)) from err return self._serialize(data, data_type, **kwargs) @@ -729,6 +730,7 @@ def url(self, name, data, data_type, **kwargs): if kwargs.get("skip_quote") is True: output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) else: output = quote(str(output), safe="") except SerializationError: @@ -741,7 +743,9 @@ def query(self, name, data, data_type, **kwargs): :param data: The data to be serialized. :param str data_type: The type to be serialized from. - :rtype: str + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list :raises: TypeError if serialization fails. :raises: ValueError if data is None """ @@ -749,10 +753,8 @@ def query(self, name, data, data_type, **kwargs): # Treat the list aside, since we don't want to encode the div separator if data_type.startswith("["): internal_data_type = data_type[1:-1] - data = [self.serialize_data(d, internal_data_type, **kwargs) if d is not None else "" for d in data] - if not kwargs.get("skip_quote", False): - data = [quote(str(d), safe="") for d in data] - return str(self.serialize_iter(data, internal_data_type, **kwargs)) + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) # Not a list, regular serialization output = self.serialize_data(data, data_type, **kwargs) @@ -803,7 +805,7 @@ def serialize_data(self, data, data_type, **kwargs): raise ValueError("No value for given attribute") try: - if data is AzureCoreNull: + if data is CoreNull: return None if data_type in self.basic_types.values(): return self.serialize_basic(data, data_type, **kwargs) @@ -823,7 +825,7 @@ def serialize_data(self, data, data_type, **kwargs): except (ValueError, TypeError) as err: msg = "Unable to serialize value: {!r} as type: {!r}." - raise_with_traceback(SerializationError, msg.format(data, data_type), err) + raise SerializationError(msg.format(data, data_type)) from err else: return self._serialize(data, **kwargs) @@ -891,6 +893,8 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): not be None or empty. :param str div: If set, this str will be used to combine the elements in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. :rtype: list, str """ if isinstance(data, str): @@ -903,9 +907,14 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): for d in data: try: serialized.append(self.serialize_data(d, iter_type, **kwargs)) - except ValueError: + except ValueError as err: + if isinstance(err, SerializationError): + raise serialized.append(None) + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + if div: serialized = ["" if s is None else str(s) for s in serialized] serialized = div.join(serialized) @@ -950,7 +959,9 @@ def serialize_dict(self, attr, dict_type, **kwargs): for key, value in attr.items(): try: serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) - except ValueError: + except ValueError as err: + if isinstance(err, SerializationError): + raise serialized[self.serialize_unicode(key)] = None if "xml" in serialization_ctxt: @@ -1160,10 +1171,10 @@ def serialize_iso(attr, **kwargs): return date + microseconds + "Z" except (ValueError, OverflowError) as err: msg = "Unable to serialize datetime object." - raise_with_traceback(SerializationError, msg, err) + raise SerializationError(msg) from err except AttributeError as err: msg = "ISO-8601 object must be valid Datetime object." - raise_with_traceback(TypeError, msg, err) + raise TypeError(msg) from err @staticmethod def serialize_unix(attr, **kwargs): @@ -1199,7 +1210,6 @@ def rest_key_extractor(attr, attr_desc, data): if working_data is None: # If at any point while following flatten JSON path see None, it means # that all properties under are None as well - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) @@ -1220,7 +1230,6 @@ def rest_key_case_insensitive_extractor(attr, attr_desc, data): if working_data is None: # If at any point while following flatten JSON path see None, it means # that all properties under are None as well - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) @@ -1271,7 +1280,7 @@ def _extract_name_from_internal_type(internal_type): xml_name = internal_type_xml_map.get("name", internal_type.__name__) xml_ns = internal_type_xml_map.get("ns", None) if xml_ns: - xml_name = "{}{}".format(xml_ns, xml_name) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) return xml_name @@ -1295,7 +1304,7 @@ def xml_key_extractor(attr, attr_desc, data): # Integrate namespace if necessary xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) if xml_ns: - xml_name = "{}{}".format(xml_ns, xml_name) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) # If it's an attribute, that's simple if xml_desc.get("attr", False): @@ -1471,7 +1480,7 @@ def _deserialize(self, target_obj, data): d_attrs[attr] = value except (AttributeError, TypeError, KeyError) as err: msg = "Unable to deserialize to object: " + class_name # type: ignore - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: additional_properties = self._build_additional_properties(attributes, data) return self._instantiate_model(response, d_attrs, additional_properties) @@ -1642,7 +1651,7 @@ def deserialize_data(self, data, data_type): except (ValueError, TypeError, AttributeError) as err: msg = "Unable to deserialize response data." msg += " Data: {}, {}".format(data, data_type) - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return self._deserialize(obj_type, data) @@ -1798,7 +1807,6 @@ def deserialize_enum(data, enum_obj): data = data.value if isinstance(data, int): # Workaround. We might consider remove it in the future. - # https://github.com/Azure/azure-rest-api-specs/issues/141 try: return list(enum_obj.__members__.values())[data] except IndexError: @@ -1852,10 +1860,10 @@ def deserialize_decimal(attr): if isinstance(attr, ET.Element): attr = attr.text try: - return decimal.Decimal(attr) # type: ignore + return decimal.Decimal(str(attr)) # type: ignore except decimal.DecimalException as err: msg = "Invalid decimal {}".format(attr) - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err @staticmethod def deserialize_long(attr): @@ -1883,7 +1891,7 @@ def deserialize_duration(attr): duration = isodate.parse_duration(attr) except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize duration object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return duration @@ -1900,7 +1908,7 @@ def deserialize_date(attr): if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore raise DeserializationError("Date must have only digits and -. Received: %s" % attr) # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. - return isodate.parse_date(attr, defaultmonth=None, defaultday=None) + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) @staticmethod def deserialize_time(attr): @@ -1935,7 +1943,7 @@ def deserialize_rfc(attr): date_obj = date_obj.astimezone(tz=TZ_UTC) except ValueError as err: msg = "Cannot deserialize to rfc datetime object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return date_obj @@ -1972,7 +1980,7 @@ def deserialize_iso(attr): raise OverflowError("Hit max or min date") except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize datetime object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return date_obj @@ -1988,9 +1996,10 @@ def deserialize_unix(attr): if isinstance(attr, ET.Element): attr = int(attr.text) # type: ignore try: + attr = int(attr) date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) except ValueError as err: msg = "Cannot deserialize to unix datetime object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return date_obj diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_types.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_types.py new file mode 100644 index 0000000000000..52104a479bf79 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_types.py @@ -0,0 +1,12 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Literal, Union + +RepeatabilityResult = Union[Literal["accepted"], Literal["rejected"]] diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_client.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_client.py index dfebacf83a9e2..2f4c04c7429f5 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_client.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_client.py @@ -11,6 +11,7 @@ from azure.core import AsyncPipelineClient from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies from azure.core.rest import AsyncHttpResponse, HttpRequest from .._serialization import Deserializer, Serializer @@ -29,7 +30,7 @@ class ClinicalMatchingClient( :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str :keyword int polling_interval: Default waiting time between two polls for LRO operations if no @@ -37,15 +38,34 @@ class ClinicalMatchingClient( """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - _endpoint = "{endpoint}/healthinsights" + _endpoint = "{endpoint}/health-insights" self._config = ClinicalMatchingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, config=self._config, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) self._serialize = Serializer() self._deserialize = Deserializer() self._serialize.client_side_validation = False - def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]: + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -69,7 +89,7 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHt } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore async def close(self) -> None: await self._client.close() diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_configuration.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_configuration.py index 314f7a5863541..c596242ae3b19 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_configuration.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_configuration.py @@ -6,22 +6,15 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import sys from typing import Any -from azure.core.configuration import Configuration from azure.core.credentials import AzureKeyCredential from azure.core.pipeline import policies from .._version import VERSION -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - -class ClinicalMatchingClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes +class ClinicalMatchingClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long """Configuration for ClinicalMatchingClient. Note that all parameters used to create this instance are saved as instance @@ -33,14 +26,13 @@ class ClinicalMatchingClientConfiguration(Configuration): # pylint: disable=too :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - super(ClinicalMatchingClientConfiguration, self).__init__(**kwargs) - api_version: Literal["2023-03-01-preview"] = kwargs.pop("api_version", "2023-03-01-preview") + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -51,6 +43,7 @@ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) self.credential = credential self.api_version = api_version kwargs.setdefault("sdk_moniker", "healthinsights-clinicalmatching/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _configure(self, **kwargs: Any) -> None: @@ -59,9 +52,9 @@ def _configure(self, **kwargs: Any) -> None: self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) - self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) self.authentication_policy = kwargs.get("authentication_policy") if self.credential and not self.authentication_policy: self.authentication_policy = policies.AzureKeyCredentialPolicy( diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_operations/_operations.py index 4de54baf9d204..7336be5c39614 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_operations/_operations.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_operations/_operations.py @@ -1,4 +1,4 @@ -# pylint: disable=too-many-lines +# pylint: disable=too-many-lines,too-many-statements # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -6,7 +6,7 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import datetime +from io import IOBase import json import sys from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload @@ -20,15 +20,14 @@ map_error, ) from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import AsyncHttpResponse from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod from azure.core.polling.async_base_polling import AsyncLROBasePolling -from azure.core.rest import HttpRequest +from azure.core.rest import AsyncHttpResponse, HttpRequest from azure.core.tracing.decorator_async import distributed_trace_async from azure.core.utils import case_insensitive_dict from ... import models as _models -from ..._model_base import AzureJSONEncoder, _deserialize +from ..._model_base import SdkJSONEncoder, _deserialize from ..._operations._operations import build_clinical_matching_match_trials_request from .._vendor import ClinicalMatchingClientMixinABC @@ -43,13 +42,8 @@ class ClinicalMatchingClientOperationsMixin(ClinicalMatchingClientMixinABC): async def _match_trials_initial( - self, - body: Union[_models.TrialMatcherData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> Optional[_models.TrialMatcherResult]: + self, body: Union[_models.TrialMatcherData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: error_map = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, @@ -62,18 +56,16 @@ async def _match_trials_initial( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[Optional[_models.TrialMatcherResult]] = kwargs.pop("cls", None) + cls: ClsType[JSON] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None - if isinstance(body, (IO, bytes)): + if isinstance(body, (IOBase, bytes)): _content = body else: - _content = json.dumps(body, cls=AzureJSONEncoder) # type: ignore + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_clinical_matching_match_trials_request( - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, + _request = build_clinical_matching_match_trials_request( content_type=content_type, api_version=self._config.api_version, content=_content, @@ -83,218 +75,12898 @@ async def _match_trials_initial( path_format_arguments = { "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [200, 202]: + if response.status_code not in [202]: + if _stream: + await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) - deserialized = None response_headers = {} - if response.status_code == 200: - deserialized = _deserialize(_models.TrialMatcherResult, response.json()) + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) - if response.status_code == 202: - response_headers["Operation-Location"] = self._deserialize( - "str", response.headers.get("Operation-Location") - ) - response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) - response_headers["Repeatability-Result"] = self._deserialize( - "str", response.headers.get("Repeatability-Result") - ) + deserialized = _deserialize(JSON, response.json()) if cls: - return cls(pipeline_response, deserialized, response_headers) + return cls(pipeline_response, deserialized, response_headers) # type: ignore - return deserialized + return deserialized # type: ignore @overload async def begin_match_trials( - self, - body: _models.TrialMatcherData, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> AsyncLROPoller[_models.TrialMatcherResult]: + self, body: _models.TrialMatcherData, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. :param body: Required. :type body: ~azure.healthinsights.clinicalmatching.models.TrialMatcherData - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns TrialMatcherResult. The TrialMatcherResult - is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", # Default + value is "ResearchStudy". resourceType. Required. + "status": "str", # active | + administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | + in-review | temporarily-closed-to-accrual | + temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", + "administratively-completed", "approved", "closed-to-accrual", + "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", + "temporarily-closed-to-accrual-and-intervention", and + "withdrawn". + "arm": [ + { + "name": "str", # Label for + study arm. Required. + "description": "str", # + Optional. Short explanation of study path. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "category": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "condition": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "contact": [ + { + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "name": "str", # Optional. + Name of an individual to contact. + "telecom": [ + { + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "rank": 0, # + Optional. Specify preferred order of use (1 = + highest). + "system": + "str", # Optional. phone | fax | email | pager | + url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and + "other". + "use": "str", + # Optional. home | work | temp | old | mobile - + purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + "value": + "str" # Optional. The actual contact point + details. + } + ] + } + ], + "contained": [ + { + "resourceType": "str", # The + type of resource. Required. + "id": "str", # Optional. + Resource Id. + "implicitRules": "str", # + Optional. A set of rules under which this content was + created. + "language": "str", # + Optional. Language of the resource content. + "meta": { + "lastUpdated": "str", + # Optional. When the resource last changed - e.g. + when the version changed. + "profile": [ + "str" # + Optional. A list of profiles (references to + `StructureDefinition + `_ + resources) that this resource claims to conform + to. The URL is a reference to + `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "source": "str", # + Optional. A uri that identifies the source system of + the resource. This provides a minimal amount of + Provenance information that can be used to track or + differentiate the source of information in the + resource. The source may identify another FHIR + server, document, message, database, etc. + "tag": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it + appears in the version portion of the URL. This value + changes when the resource is created, updated, or + deleted. + } + } + ], + "description": "str", # Optional. What this + is study doing. + "enrollment": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "focus": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "id": "str", # Optional. Resource Id. + "identifier": [ + { + "assigner": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": ..., + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": ..., + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + } + ], + "implicitRules": "str", # Optional. A set of + rules under which this content was created. + "keyword": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "language": "str", # Optional. Language of + the resource content. + "location": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "meta": { + "lastUpdated": "str", # Optional. + When the resource last changed - e.g. when the version + changed. + "profile": [ + "str" # Optional. A list of + profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. The + URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "source": "str", # Optional. A uri + that identifies the source system of the resource. This + provides a minimal amount of Provenance information that can + be used to track or differentiate the source of information + in the resource. The source may identify another FHIR server, + document, message, database, etc. + "tag": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "versionId": "str" # Optional. The + version specific identifier, as it appears in the version + portion of the URL. This value changes when the resource is + created, updated, or deleted. + }, + "modifierExtension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "note": [ + { + "text": "str", # The + annotation - text content (as markdown). Required. + "authorString": "str", # + Optional. Individual responsible for the annotation. + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "time": "str" # Optional. + When the annotation was made. + } + ], + "objective": [ + { + "name": "str", # Label for + the objective. Required. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "partOf": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "phase": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "primaryPurposeType": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "principalInvestigator": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "protocol": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "reasonStopped": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "site": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "sponsor": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "text": { + "div": "str", # xhtml. Required. + "status": "str", # generated, + extensions, additional, empty. Required. + "extension": [ + { + "url": "str", # + Source of the definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, + # Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "valueDateTime": + "str", # Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": + { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": + "str", # Optional. Text alternative for the + resource. + "identifier": + { + "assigner": ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. The namespace + for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | official | + temp | secondary | old (If known). + "value": "str" # Optional. The value that is + unique. + }, + "reference": + "str", # Optional. Literal reference, Relative, + internal or absolute URL. + "type": "str" + # Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": + 0, # Number of sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": + 0.0, # Number of milliseconds between samples. + Required. + "data": + "str", # Optional. Decimal values with spaces, + or "E" | "U" | "L". + "factor": + 0.0, # Optional. Multiply data by this before + adding to origin. + "lowerLimit": + 0.0, # Optional. Lower limit of detection. + "upperLimit": + 0.0 # Optional. Upper limit of detection. + }, + "valueString": "str", + # Optional. Value as string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str" # Optional. Unique id + for inter-element referencing. + }, + "title": "str" # Optional. Name for this + study. + } + ], + "registryFilters": [ + { + "conditions": [ + "str" # Optional. Trials with any of + the given medical conditions will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the medical + conditions. + ], + "facilityAreas": [ + { + "geometry": { + "coordinates": [ + 0.0 # + Coordinates of the area circle's center, + represented according to the ``GeoJSON`` + standard. This is an array of 2 decimal numbers, + longitude and latitude (precisely in this order). + Required. + ], + "type": "str" # + ``GeoJSON`` geometry type. Required. "Point" + }, + "properties": { + "radius": 0.0, # The + radius of the area's circle, in meters. Required. + "subType": "str" # + ``GeoJSON`` object sub-type. Required. "Circle" + }, + "type": "str" # ``GeoJSON`` + type. Required. "Feature" + } + ], + "facilityLocations": [ + { + "countryOrRegion": "str", # + Country/region name. Required. + "city": "str", # Optional. + City name. + "state": "str" # Optional. + State name. + } + ], + "facilityNames": [ + "str" # Optional. Trials with any of + the given facility names will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial facility names. + ], + "ids": [ + "str" # Optional. Trials with any of + the given identifiers will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial identifiers. + ], + "phases": [ + "str" # Optional. Trials with any of + the given phases will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the phases. + ], + "purposes": [ + "str" # Optional. Trials with any of + the given purposes will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the purposes. + ], + "recruitmentStatuses": [ + "str" # Optional. Trials with any of + the given recruitment statuses will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the recruitment + statuses. + ], + "sources": [ + "str" # Optional. Trials with any of + the given sources will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the sources. + ], + "sponsors": [ + "str" # Optional. Trials with any of + the given sponsors will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the sponsors. + ], + "studyTypes": [ + "str" # Optional. Trials with any of + the given study types will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the study types. + ] + } + ] + }, + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ @overload async def begin_match_trials( - self, - body: JSON, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> AsyncLROPoller[_models.TrialMatcherResult]: + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. :param body: Required. :type body: JSON - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns TrialMatcherResult. The TrialMatcherResult - is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ @overload async def begin_match_trials( - self, - body: IO, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> AsyncLROPoller[_models.TrialMatcherResult]: + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. :param body: Required. - :type body: IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime + :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns TrialMatcherResult. The TrialMatcherResult - is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ @distributed_trace_async async def begin_match_trials( - self, - body: Union[_models.TrialMatcherData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> AsyncLROPoller[_models.TrialMatcherResult]: + self, body: Union[_models.TrialMatcherData, JSON, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. - :param body: Is one of the following types: TrialMatcherData, JSON, IO Required. - :type body: ~azure.healthinsights.clinicalmatching.models.TrialMatcherData or JSON or IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime + :param body: Is one of the following types: TrialMatcherData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.clinicalmatching.models.TrialMatcherData or JSON or IO[bytes] :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default value is None. :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns TrialMatcherResult. The TrialMatcherResult - is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", # Default + value is "ResearchStudy". resourceType. Required. + "status": "str", # active | + administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | + in-review | temporarily-closed-to-accrual | + temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", + "administratively-completed", "approved", "closed-to-accrual", + "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", + "temporarily-closed-to-accrual-and-intervention", and + "withdrawn". + "arm": [ + { + "name": "str", # Label for + study arm. Required. + "description": "str", # + Optional. Short explanation of study path. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "category": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "condition": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "contact": [ + { + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "name": "str", # Optional. + Name of an individual to contact. + "telecom": [ + { + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "rank": 0, # + Optional. Specify preferred order of use (1 = + highest). + "system": + "str", # Optional. phone | fax | email | pager | + url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and + "other". + "use": "str", + # Optional. home | work | temp | old | mobile - + purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + "value": + "str" # Optional. The actual contact point + details. + } + ] + } + ], + "contained": [ + { + "resourceType": "str", # The + type of resource. Required. + "id": "str", # Optional. + Resource Id. + "implicitRules": "str", # + Optional. A set of rules under which this content was + created. + "language": "str", # + Optional. Language of the resource content. + "meta": { + "lastUpdated": "str", + # Optional. When the resource last changed - e.g. + when the version changed. + "profile": [ + "str" # + Optional. A list of profiles (references to + `StructureDefinition + `_ + resources) that this resource claims to conform + to. The URL is a reference to + `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "source": "str", # + Optional. A uri that identifies the source system of + the resource. This provides a minimal amount of + Provenance information that can be used to track or + differentiate the source of information in the + resource. The source may identify another FHIR + server, document, message, database, etc. + "tag": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it + appears in the version portion of the URL. This value + changes when the resource is created, updated, or + deleted. + } + } + ], + "description": "str", # Optional. What this + is study doing. + "enrollment": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "focus": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "id": "str", # Optional. Resource Id. + "identifier": [ + { + "assigner": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": ..., + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": ..., + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + } + ], + "implicitRules": "str", # Optional. A set of + rules under which this content was created. + "keyword": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "language": "str", # Optional. Language of + the resource content. + "location": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "meta": { + "lastUpdated": "str", # Optional. + When the resource last changed - e.g. when the version + changed. + "profile": [ + "str" # Optional. A list of + profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. The + URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "source": "str", # Optional. A uri + that identifies the source system of the resource. This + provides a minimal amount of Provenance information that can + be used to track or differentiate the source of information + in the resource. The source may identify another FHIR server, + document, message, database, etc. + "tag": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "versionId": "str" # Optional. The + version specific identifier, as it appears in the version + portion of the URL. This value changes when the resource is + created, updated, or deleted. + }, + "modifierExtension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "note": [ + { + "text": "str", # The + annotation - text content (as markdown). Required. + "authorString": "str", # + Optional. Individual responsible for the annotation. + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "time": "str" # Optional. + When the annotation was made. + } + ], + "objective": [ + { + "name": "str", # Label for + the objective. Required. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "partOf": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "phase": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "primaryPurposeType": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "principalInvestigator": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "protocol": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "reasonStopped": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "site": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "sponsor": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "text": { + "div": "str", # xhtml. Required. + "status": "str", # generated, + extensions, additional, empty. Required. + "extension": [ + { + "url": "str", # + Source of the definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, + # Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "valueDateTime": + "str", # Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": + { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": + "str", # Optional. Text alternative for the + resource. + "identifier": + { + "assigner": ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. The namespace + for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | official | + temp | secondary | old (If known). + "value": "str" # Optional. The value that is + unique. + }, + "reference": + "str", # Optional. Literal reference, Relative, + internal or absolute URL. + "type": "str" + # Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": + 0, # Number of sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": + 0.0, # Number of milliseconds between samples. + Required. + "data": + "str", # Optional. Decimal values with spaces, + or "E" | "U" | "L". + "factor": + 0.0, # Optional. Multiply data by this before + adding to origin. + "lowerLimit": + 0.0, # Optional. Lower limit of detection. + "upperLimit": + 0.0 # Optional. Upper limit of detection. + }, + "valueString": "str", + # Optional. Value as string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str" # Optional. Unique id + for inter-element referencing. + }, + "title": "str" # Optional. Name for this + study. + } + ], + "registryFilters": [ + { + "conditions": [ + "str" # Optional. Trials with any of + the given medical conditions will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the medical + conditions. + ], + "facilityAreas": [ + { + "geometry": { + "coordinates": [ + 0.0 # + Coordinates of the area circle's center, + represented according to the ``GeoJSON`` + standard. This is an array of 2 decimal numbers, + longitude and latitude (precisely in this order). + Required. + ], + "type": "str" # + ``GeoJSON`` geometry type. Required. "Point" + }, + "properties": { + "radius": 0.0, # The + radius of the area's circle, in meters. Required. + "subType": "str" # + ``GeoJSON`` object sub-type. Required. "Circle" + }, + "type": "str" # ``GeoJSON`` + type. Required. "Feature" + } + ], + "facilityLocations": [ + { + "countryOrRegion": "str", # + Country/region name. Required. + "city": "str", # Optional. + City name. + "state": "str" # Optional. + State name. + } + ], + "facilityNames": [ + "str" # Optional. Trials with any of + the given facility names will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial facility names. + ], + "ids": [ + "str" # Optional. Trials with any of + the given identifiers will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial identifiers. + ], + "phases": [ + "str" # Optional. Trials with any of + the given phases will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the phases. + ], + "purposes": [ + "str" # Optional. Trials with any of + the given purposes will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the purposes. + ], + "recruitmentStatuses": [ + "str" # Optional. Trials with any of + the given recruitment statuses will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the recruitment + statuses. + ], + "sources": [ + "str" # Optional. Trials with any of + the given sources will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the sources. + ], + "sponsors": [ + "str" # Optional. Trials with any of + the given sponsors will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the sponsors. + ], + "studyTypes": [ + "str" # Optional. Trials with any of + the given study types will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the study types. + ] + } + ] + }, + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[_models.TrialMatcherResult] = kwargs.pop("cls", None) + cls: ClsType[_models.TrialMatcherInferenceResult] = kwargs.pop("cls", None) polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token: Optional[str] = kwargs.pop("continuation_token", None) if cont_token is None: raw_result = await self._match_trials_initial( - body=body, - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, - content_type=content_type, - cls=lambda x, y, z: x, - headers=_headers, - params=_params, - **kwargs + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs ) kwargs.pop("error_map", None) def get_long_running_output(pipeline_response): + response_headers = {} response = pipeline_response.http_response - deserialized = _deserialize(_models.TrialMatcherResult, response.json()) + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.TrialMatcherInferenceResult, response.json().get("result")) if cls: - return cls(pipeline_response, deserialized, {}) # type: ignore + return cls(pipeline_response, deserialized, response_headers) # type: ignore return deserialized path_format_arguments = { @@ -311,10 +12983,12 @@ def get_long_running_output(pipeline_response): else: polling_method = polling if cont_token: - return AsyncLROPoller.from_continuation_token( + return AsyncLROPoller[_models.TrialMatcherInferenceResult].from_continuation_token( polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output, ) - return AsyncLROPoller(self._client, raw_result, get_long_running_output, polling_method) # type: ignore + return AsyncLROPoller[_models.TrialMatcherInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/__init__.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/__init__.py index d164ec7e9a556..111b4eaff90f8 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/__init__.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/__init__.py @@ -6,103 +6,163 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._models import AcceptedAge -from ._models import AcceptedAgeRange +from ._models import Annotation from ._models import AreaGeometry from ._models import AreaProperties from ._models import ClinicalCodedElement from ._models import ClinicalNoteEvidence -from ._models import ClinicalTrialDemographics -from ._models import ClinicalTrialDetails from ._models import ClinicalTrialMetadata from ._models import ClinicalTrialRegistryFilter from ._models import ClinicalTrialResearchFacility from ._models import ClinicalTrials +from ._models import CodeableConcept +from ._models import Coding +from ._models import Condition +from ._models import ConditionStage +from ._models import ContactDetail from ._models import ContactDetails +from ._models import ContactPoint +from ._models import DocumentAdministrativeMetadata +from ._models import DocumentAuthor from ._models import DocumentContent +from ._models import DomainResource +from ._models import Element +from ._models import Encounter from ._models import Error from ._models import ExtendedClinicalCodedElement +from ._models import Extension from ._models import GeographicArea from ._models import GeographicLocation +from ._models import HealthInsightsOperationStatus +from ._models import Identifier from ._models import InnerError +from ._models import Meta +from ._models import Narrative +from ._models import Observation +from ._models import ObservationComponent +from ._models import ObservationReferenceRange +from ._models import OrderedProcedure +from ._models import PatientDetails from ._models import PatientDocument -from ._models import PatientInfo from ._models import PatientRecord +from ._models import Period +from ._models import Quantity +from ._models import Range +from ._models import Ratio +from ._models import Reference +from ._models import ResearchStudy +from ._models import ResearchStudyArm +from ._models import ResearchStudyObjective +from ._models import Resource +from ._models import SampledData +from ._models import TimePeriod from ._models import TrialMatcherData from ._models import TrialMatcherInference from ._models import TrialMatcherInferenceEvidence +from ._models import TrialMatcherInferenceResult from ._models import TrialMatcherModelConfiguration from ._models import TrialMatcherPatientResult -from ._models import TrialMatcherResult -from ._models import TrialMatcherResults -from ._enums import AgeUnit from ._enums import ClinicalDocumentType -from ._enums import ClinicalTrialAcceptedSex from ._enums import ClinicalTrialPhase from ._enums import ClinicalTrialPurpose from ._enums import ClinicalTrialRecruitmentStatus from ._enums import ClinicalTrialSource from ._enums import ClinicalTrialStudyType +from ._enums import ContactPointSystem +from ._enums import ContactPointUse from ._enums import DocumentContentSourceType from ._enums import DocumentType +from ._enums import EncounterClass from ._enums import GeoJsonGeometryType from ._enums import GeoJsonPropertiesSubType from ._enums import GeoJsonType from ._enums import JobStatus -from ._enums import PatientInfoSex -from ._enums import RepeatabilityResultType +from ._enums import ObservationStatusCodeType +from ._enums import PatientSex +from ._enums import ResearchStudyStatusCodeType +from ._enums import SpecialtyType from ._enums import TrialMatcherInferenceType from ._patch import __all__ as _patch_all from ._patch import * # pylint: disable=unused-wildcard-import from ._patch import patch_sdk as _patch_sdk __all__ = [ - "AcceptedAge", - "AcceptedAgeRange", + "Annotation", "AreaGeometry", "AreaProperties", "ClinicalCodedElement", "ClinicalNoteEvidence", - "ClinicalTrialDemographics", - "ClinicalTrialDetails", "ClinicalTrialMetadata", "ClinicalTrialRegistryFilter", "ClinicalTrialResearchFacility", "ClinicalTrials", + "CodeableConcept", + "Coding", + "Condition", + "ConditionStage", + "ContactDetail", "ContactDetails", + "ContactPoint", + "DocumentAdministrativeMetadata", + "DocumentAuthor", "DocumentContent", + "DomainResource", + "Element", + "Encounter", "Error", "ExtendedClinicalCodedElement", + "Extension", "GeographicArea", "GeographicLocation", + "HealthInsightsOperationStatus", + "Identifier", "InnerError", + "Meta", + "Narrative", + "Observation", + "ObservationComponent", + "ObservationReferenceRange", + "OrderedProcedure", + "PatientDetails", "PatientDocument", - "PatientInfo", "PatientRecord", + "Period", + "Quantity", + "Range", + "Ratio", + "Reference", + "ResearchStudy", + "ResearchStudyArm", + "ResearchStudyObjective", + "Resource", + "SampledData", + "TimePeriod", "TrialMatcherData", "TrialMatcherInference", "TrialMatcherInferenceEvidence", + "TrialMatcherInferenceResult", "TrialMatcherModelConfiguration", "TrialMatcherPatientResult", - "TrialMatcherResult", - "TrialMatcherResults", - "AgeUnit", "ClinicalDocumentType", - "ClinicalTrialAcceptedSex", "ClinicalTrialPhase", "ClinicalTrialPurpose", "ClinicalTrialRecruitmentStatus", "ClinicalTrialSource", "ClinicalTrialStudyType", + "ContactPointSystem", + "ContactPointUse", "DocumentContentSourceType", "DocumentType", + "EncounterClass", "GeoJsonGeometryType", "GeoJsonPropertiesSubType", "GeoJsonType", "JobStatus", - "PatientInfoSex", - "RepeatabilityResultType", + "ObservationStatusCodeType", + "PatientSex", + "ResearchStudyStatusCodeType", + "SpecialtyType", "TrialMatcherInferenceType", ] __all__.extend([p for p in _patch_all if p not in __all__]) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_enums.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_enums.py index aaf819fec7af7..afaf46c928884 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_enums.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_enums.py @@ -10,35 +10,17 @@ from azure.core import CaseInsensitiveEnumMeta -class AgeUnit(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Possible units for a person's age.""" - - YEARS = "years" - MONTHS = "months" - DAYS = "days" - - class ClinicalDocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): """The type of the clinical document.""" CONSULTATION = "consultation" DISCHARGE_SUMMARY = "dischargeSummary" HISTORY_AND_PHYSICAL = "historyAndPhysical" + RADIOLOGY_REPORT = "radiologyReport" PROCEDURE = "procedure" PROGRESS = "progress" - IMAGING = "imaging" LABORATORY = "laboratory" - PATHOLOGY = "pathology" - - -class ClinicalTrialAcceptedSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Possible values for the Sex eligibility criterion as accepted by clinical trials, which - indicates the sex of people who may participate in a clinical study. - """ - - ALL = "all" - FEMALE = "female" - MALE = "male" + PATHOLOGY_REPORT = "pathologyReport" class ClinicalTrialPhase(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -92,6 +74,44 @@ class ClinicalTrialStudyType(str, Enum, metaclass=CaseInsensitiveEnumMeta): PATIENT_REGISTRIES = "patientRegistries" +class ContactPointSystem(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Contact Point System + see https://www.hl7.org/fhir/R4/valueset-contact-point-system.html. + """ + + PHONE = "phone" + """Phone""" + FAX = "fax" + """Fax""" + EMAIL = "email" + """Email""" + PAGER = "pager" + """Pager""" + URL = "url" + """Url""" + SMS = "sms" + """Sms""" + OTHER = "other" + """Other""" + + +class ContactPointUse(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Contact Point Use + See: http://hl7.org/fhir/ValueSet/contact-point-use. + """ + + HOME = "home" + """Home""" + WORK = "work" + """Work""" + TEMP = "temp" + """Temp""" + OLD = "old" + """Old""" + MOBILE = "mobile" + """Mobile""" + + class DocumentContentSourceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): """The type of the content's source. In case the source type is 'inline', the content is given as a string (for instance, text). @@ -99,7 +119,9 @@ class DocumentContentSourceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): """ INLINE = "inline" + """The content is given as a string (for instance, text).""" REFERENCE = "reference" + """The content is given as a URI.""" class DocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -113,6 +135,35 @@ class DocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): GENOMIC_SEQUENCING = "genomicSequencing" +class EncounterClass(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR + value set--http://....). + """ + + IN_PATIENT = "inpatient" + """A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned + to a location where patients generally stay at least overnight and provided with room, board, + and continuous nursing service.""" + AMBULATORY = "ambulatory" + """The term ambulatory usually implies that the patient has come to the location and is not + assigned to a bed. Sometimes referred to as an outpatient encounter.""" + OBSERVATION = "observation" + """An encounter where the patient usually will start in different encounter, such as one in the + emergency department but then transition to this type of encounter because they require a + significant period of treatment and monitoring to determine whether or not their condition + warrants an inpatient admission or discharge.""" + EMERGENCY = "emergency" + """A patient encounter that takes place at a dedicated healthcare service delivery location where + the patient receives immediate evaluation and treatment, provided until the patient can be + discharged or responsibility for the patient's care is transferred elsewhere (for example, the + patient could be admitted as an inpatient or transferred to another facility.""" + VIRTUAL = "virtual" + """A patient encounter where the patient is not physically present for the encounter, such as in a + telehealth encounter, phone call, or electronic communication.""" + HEALTH_HOME = "healthHome" + """Healthcare encounter that takes place in the residence of the patient or a designee""" + + class GeoJsonGeometryType(str, Enum, metaclass=CaseInsensitiveEnumMeta): """``GeoJSON`` geometry type.""" @@ -138,10 +189,38 @@ class JobStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): RUNNING = "running" SUCCEEDED = "succeeded" FAILED = "failed" - PARTIALLY_COMPLETED = "partiallyCompleted" + CANCELED = "canceled" -class PatientInfoSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): +class ObservationStatusCodeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Observation Status + Based on `FHIR ObservationStatus + `_. + """ + + REGISTERED = "registered" + """The existence of the observation is registered, but there is no result yet available.""" + PRELIMINARY = "preliminary" + """This is an initial or interim observation: data may be incomplete or unverified.""" + FINAL = "final" + """The observation is complete and verified by an authorized person.""" + AMENDED = "amended" + """Subsequent to being Final, the observation has been modified subsequent. This includes + updates/new information and corrections.""" + CORRECTED = "corrected" + """Subsequent to being Final, the observation has been modified to correct an error in the test + result.""" + CANCELLED = "cancelled" + """The observation is unavailable because the measurement was not started or not completed (also + sometimes called "aborted").""" + ENTERED_IN_ERROR = "entered-in-error" + """The observation has been withdrawn following previous final release.""" + UNKNOWN = "unknown" + """The observation status is unknown. Note that "unknown" is a value of last resort and every + attempt should be made to provide a meaningful value other than "unknown".""" + + +class PatientSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): """The patient's sex.""" FEMALE = "female" @@ -149,11 +228,46 @@ class PatientInfoSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): UNSPECIFIED = "unspecified" -class RepeatabilityResultType(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Type of RepeatabilityResultType.""" +class ResearchStudyStatusCodeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """https://www.hl7.org/fhir/R4/codesystem-research-study-status.html.""" + + ACTIVE = "active" + """The study is open for accrual.""" + ADMINISTRATIVELY_COMPLETED = "administratively-completed" + """Study is completed prematurely and will not resume; patients are no longer examined nor + treated.""" + APPROVED = "approved" + """Protocol is approved by the review board.""" + CLOSED_TO_ACCRUAL = "closed-to-accrual" + """Study is closed for accrual; patients can be examined and treated.""" + CLOSED_TO_ACCRUAL_AND_INTERVENTION = "closed-to-accrual-and-intervention" + """The study is closed to accrual and intervention, i.e. the study is closed to enrollment, all + study subjects have completed treatment or intervention but are still being followed according + to the primary objective of the study.""" + COMPLETED = "completed" + """Study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study + subjects have completed treatment or intervention but are still being followed according to the + primary objective of the study.""" + DISAPPROVED = "disapproved" + """Protocol was disapproved by the review board.""" + IN_REVIEW = "in-review" + """Protocol is submitted to the review board for approval.""" + TEMPORARILY_CLOSED_TO_ACCRUAL = "temporarily-closed-to-accrual" + """The study is temporarily closed to accrual; a pause in accrual while study is reviewed, but is + expected to resume.""" + TEMPORARILY_CLOSED_TO_ACCRUAL_AND_INTERVENTION = "temporarily-closed-to-accrual-and-intervention" + """Study is temporarily closed for accrual; can be potentially resumed in the future""" + WITHDRAWN = "withdrawn" + """Protocol was withdrawn by the lead organization.""" + + +class SpecialtyType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the type of the Specialty.""" - ACCEPTED = "accepted" - REJECTED = "rejected" + PATHOLOGY = "pathology" + """pathology""" + RADIOLOGY = "radiology" + """radiology""" class TrialMatcherInferenceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_models.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_models.py index c9627ce32ad38..a4da7855bc320 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_models.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_models.py @@ -8,39 +8,37 @@ # -------------------------------------------------------------------------- import datetime -from typing import Any, List, Mapping, Optional, TYPE_CHECKING, Union, overload +from typing import Any, Dict, List, Literal, Mapping, Optional, TYPE_CHECKING, Union, overload from .. import _model_base -from .._model_base import rest_field +from .._model_base import rest_discriminator, rest_field if TYPE_CHECKING: # pylint: disable=unused-import,ungrouped-imports from .. import models as _models -class AcceptedAge(_model_base.Model): - """A person's age, given as a number (value) and a unit (e.g. years, months). +class Element(_model_base.Model): + """The base definition for all elements contained inside a resource. + Based on `FHIR Element `_. - All required parameters must be populated in order to send to Azure. - - :ivar unit: Possible units for a person's age. Required. Known values are: "years", "months", - and "days". - :vartype unit: str or ~azure.healthinsights.clinicalmatching.models.AgeUnit - :ivar value: The number of years/months/days that represents the person's age. Required. - :vartype value: float + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] """ - unit: Union[str, "_models.AgeUnit"] = rest_field() - """Possible units for a person's age. Required. Known values are: \"years\", \"months\", and \"days\".""" - value: float = rest_field() - """The number of years/months/days that represents the person's age. Required. """ + id: Optional[str] = rest_field() + """Unique id for inter-element referencing.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" @overload def __init__( self, *, - unit: Union[str, "_models.AgeUnit"], - value: float, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, ): ... @@ -55,27 +53,40 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class AcceptedAgeRange(_model_base.Model): - """A definition of the range of ages accepted by a clinical trial. Contains a minimum age and/or a - maximum age. +class Annotation(Element): + """A text note which also contains information about who made the statement and when + Based on `FHIR Annotation `_. + + All required parameters must be populated in order to send to server. - :ivar minimum_age: A person's age, given as a number (value) and a unit (e.g. years, months). - :vartype minimum_age: ~azure.healthinsights.clinicalmatching.models.AcceptedAge - :ivar maximum_age: A person's age, given as a number (value) and a unit (e.g. years, months). - :vartype maximum_age: ~azure.healthinsights.clinicalmatching.models.AcceptedAge + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar author_string: Individual responsible for the annotation. + :vartype author_string: str + :ivar time: When the annotation was made. + :vartype time: str + :ivar text: The annotation - text content (as markdown). Required. + :vartype text: str """ - minimum_age: Optional["_models.AcceptedAge"] = rest_field(name="minimumAge") - """A person's age, given as a number (value) and a unit (e.g. years, months). """ - maximum_age: Optional["_models.AcceptedAge"] = rest_field(name="maximumAge") - """A person's age, given as a number (value) and a unit (e.g. years, months). """ + author_string: Optional[str] = rest_field(name="authorString") + """Individual responsible for the annotation.""" + time: Optional[str] = rest_field() + """When the annotation was made.""" + text: str = rest_field() + """The annotation - text content (as markdown). Required.""" @overload def __init__( self, *, - minimum_age: Optional["_models.AcceptedAge"] = None, - maximum_age: Optional["_models.AcceptedAge"] = None, + text: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + author_string: Optional[str] = None, + time: Optional[str] = None, ): ... @@ -93,7 +104,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class AreaGeometry(_model_base.Model): """``GeoJSON`` geometry, representing the area circle's center. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar type: ``GeoJSON`` geometry type. Required. "Point" :vartype type: str or ~azure.healthinsights.clinicalmatching.models.GeoJsonGeometryType @@ -108,13 +119,14 @@ class AreaGeometry(_model_base.Model): """``GeoJSON`` geometry type. Required. \"Point\"""" coordinates: List[float] = rest_field() """Coordinates of the area circle's center, represented according to the ``GeoJSON`` standard. -This is an array of 2 decimal numbers, longitude and latitude (precisely in this order). Required. """ + This is an array of 2 decimal numbers, longitude and latitude (precisely in this order). + Required.""" @overload def __init__( self, *, - type: Union[str, "_models.GeoJsonGeometryType"], # pylint: disable=redefined-builtin + type: Union[str, "_models.GeoJsonGeometryType"], coordinates: List[float], ): ... @@ -133,7 +145,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class AreaProperties(_model_base.Model): """``GeoJSON`` object properties. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar sub_type: ``GeoJSON`` object sub-type. Required. "Circle" :vartype sub_type: str or @@ -145,7 +157,7 @@ class AreaProperties(_model_base.Model): sub_type: Union[str, "_models.GeoJsonPropertiesSubType"] = rest_field(name="subType") """``GeoJSON`` object sub-type. Required. \"Circle\"""" radius: float = rest_field() - """The radius of the area's circle, in meters. Required. """ + """The radius of the area's circle, in meters. Required.""" @overload def __init__( @@ -170,7 +182,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class ClinicalCodedElement(_model_base.Model): """A piece of clinical information, expressed as a code in a clinical coding system. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar system: The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. :vartype system: str @@ -183,13 +195,13 @@ class ClinicalCodedElement(_model_base.Model): """ system: str = rest_field() - """The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. """ + """The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required.""" code: str = rest_field() - """The code within the given clinical coding system. Required. """ + """The code within the given clinical coding system. Required.""" name: Optional[str] = rest_field() - """The name of this coded concept in the coding system. """ + """The name of this coded concept in the coding system.""" value: Optional[str] = rest_field() - """A value associated with the code within the given clinical coding system. """ + """A value associated with the code within the given clinical coding system.""" @overload def __init__( @@ -216,7 +228,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class ClinicalNoteEvidence(_model_base.Model): """A piece of evidence from a clinical note (text document). - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar id: The identifier of the document containing the evidence. Required. :vartype id: str @@ -229,13 +241,13 @@ class ClinicalNoteEvidence(_model_base.Model): """ id: str = rest_field() - """The identifier of the document containing the evidence. Required. """ + """The identifier of the document containing the evidence. Required.""" text: Optional[str] = rest_field() - """The actual text span which is evidence for the inference. """ + """The actual text span which is evidence for the inference.""" offset: int = rest_field() - """The start index of the evidence text span in the document (0 based). Required. """ + """The start index of the evidence text span in the document (0 based). Required.""" length: int = rest_field() - """The length of the evidence text span. Required. """ + """The length of the evidence text span. Required.""" @overload def __init__( @@ -259,96 +271,10 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class ClinicalTrialDemographics(_model_base.Model): - """Demographic criteria for a clinical trial. - - :ivar accepted_sex: Indication of the sex of people who may participate in the clinical trial. - Known values are: "all", "female", and "male". - :vartype accepted_sex: str or - ~azure.healthinsights.clinicalmatching.models.ClinicalTrialAcceptedSex - :ivar accepted_age_range: A definition of the range of ages accepted by a clinical trial. - Contains a minimum age and/or a maximum age. - :vartype accepted_age_range: ~azure.healthinsights.clinicalmatching.models.AcceptedAgeRange - """ - - accepted_sex: Optional[Union[str, "_models.ClinicalTrialAcceptedSex"]] = rest_field(name="acceptedSex") - """Indication of the sex of people who may participate in the clinical trial. Known values are: \"all\", - \"female\", and \"male\". """ - accepted_age_range: Optional["_models.AcceptedAgeRange"] = rest_field(name="acceptedAgeRange") - """A definition of the range of ages accepted by a clinical trial. Contains a minimum age and/or a maximum age. """ - - @overload - def __init__( - self, - *, - accepted_sex: Optional[Union[str, "_models.ClinicalTrialAcceptedSex"]] = None, - accepted_age_range: Optional["_models.AcceptedAgeRange"] = None, - ): - ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - -class ClinicalTrialDetails(_model_base.Model): - """A description of a clinical trial. - - All required parameters must be populated in order to send to Azure. - - :ivar id: A given identifier for the clinical trial. Has to be unique within a list of clinical - trials. Required. - :vartype id: str - :ivar eligibility_criteria_text: The eligibility criteria of the clinical trial (inclusion and - exclusion), given as text. - :vartype eligibility_criteria_text: str - :ivar demographics: Demographic criteria for a clinical trial. - :vartype demographics: ~azure.healthinsights.clinicalmatching.models.ClinicalTrialDemographics - :ivar metadata: Trial data which is of interest to the potential participant. Required. - :vartype metadata: ~azure.healthinsights.clinicalmatching.models.ClinicalTrialMetadata - """ - - id: str = rest_field() - """A given identifier for the clinical trial. Has to be unique within a list of clinical trials. Required. """ - eligibility_criteria_text: Optional[str] = rest_field(name="eligibilityCriteriaText") - """The eligibility criteria of the clinical trial (inclusion and exclusion), given as text. """ - demographics: Optional["_models.ClinicalTrialDemographics"] = rest_field() - """Demographic criteria for a clinical trial. """ - metadata: "_models.ClinicalTrialMetadata" = rest_field() - """Trial data which is of interest to the potential participant. Required. """ - - @overload - def __init__( - self, - *, - id: str, # pylint: disable=redefined-builtin - metadata: "_models.ClinicalTrialMetadata", - eligibility_criteria_text: Optional[str] = None, - demographics: Optional["_models.ClinicalTrialDemographics"] = None, - ): - ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - class ClinicalTrialMetadata(_model_base.Model): """Trial data which is of interest to the potential participant. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar phases: Phases which are relevant for the clinical trial. Each clinical trial can be in a certain phase or in multiple phases. @@ -376,23 +302,25 @@ class ClinicalTrialMetadata(_model_base.Model): phases: Optional[List[Union[str, "_models.ClinicalTrialPhase"]]] = rest_field() """Phases which are relevant for the clinical trial. -Each clinical trial can be in a certain phase or in multiple phases. """ + Each clinical trial can be in a certain phase or in multiple phases.""" study_type: Optional[Union[str, "_models.ClinicalTrialStudyType"]] = rest_field(name="studyType") - """Possible study types of a clinical trial. Known values are: \"interventional\", \"observational\", - \"expandedAccess\", and \"patientRegistries\". """ + """Possible study types of a clinical trial. Known values are: \"interventional\", + \"observational\", \"expandedAccess\", and \"patientRegistries\".""" recruitment_status: Optional[Union[str, "_models.ClinicalTrialRecruitmentStatus"]] = rest_field( name="recruitmentStatus" ) - """Possible recruitment status of a clinical trial. Known values are: \"unknownStatus\", \"notYetRecruiting\", - \"recruiting\", and \"enrollingByInvitation\". """ + """Possible recruitment status of a clinical trial. Known values are: \"unknownStatus\", + \"notYetRecruiting\", \"recruiting\", and \"enrollingByInvitation\".""" conditions: List[str] = rest_field() - """Medical conditions and their synonyms which are relevant for the clinical trial, given as strings. Required. """ + """Medical conditions and their synonyms which are relevant for the clinical trial, given as + strings. Required.""" sponsors: Optional[List[str]] = rest_field() - """Sponsors/collaborators involved with the trial. """ + """Sponsors/collaborators involved with the trial.""" contacts: Optional[List["_models.ContactDetails"]] = rest_field() - """Contact details of the trial administrators, for patients that want to participate in the trial. """ + """Contact details of the trial administrators, for patients that want to participate in the + trial.""" facilities: Optional[List["_models.ClinicalTrialResearchFacility"]] = rest_field() - """Research facilities where the clinical trial is conducted. """ + """Research facilities where the clinical trial is conducted.""" @overload def __init__( @@ -475,40 +403,51 @@ class ClinicalTrialRegistryFilter(_model_base.Model): # pylint: disable=too-man """ conditions: Optional[List[str]] = rest_field() - """Trials with any of the given medical conditions will be included in the selection (provided that other - limitations are satisfied). Leaving this list empty will not limit the medical conditions. """ + """Trials with any of the given medical conditions will be included in the selection (provided + that other limitations are satisfied). + Leaving this list empty will not limit the medical conditions.""" study_types: Optional[List[Union[str, "_models.ClinicalTrialStudyType"]]] = rest_field(name="studyTypes") - """Trials with any of the given study types will be included in the selection (provided that other limitations - are satisfied). Leaving this list empty will not limit the study types. """ + """Trials with any of the given study types will be included in the selection (provided that other + limitations are satisfied). + Leaving this list empty will not limit the study types.""" recruitment_statuses: Optional[List[Union[str, "_models.ClinicalTrialRecruitmentStatus"]]] = rest_field( name="recruitmentStatuses" ) - """Trials with any of the given recruitment statuses will be included in the selection (provided that other - limitations are satisfied). Leaving this list empty will not limit the recruitment statuses. """ + """Trials with any of the given recruitment statuses will be included in the selection (provided + that other limitations are satisfied). + Leaving this list empty will not limit the recruitment statuses.""" sponsors: Optional[List[str]] = rest_field() - """Trials with any of the given sponsors will be included in the selection (provided that other limitations are - satisfied). Leaving this list empty will not limit the sponsors. """ + """Trials with any of the given sponsors will be included in the selection (provided that other + limitations are satisfied). + Leaving this list empty will not limit the sponsors.""" phases: Optional[List[Union[str, "_models.ClinicalTrialPhase"]]] = rest_field() - """Trials with any of the given phases will be included in the selection (provided that other limitations are - satisfied). Leaving this list empty will not limit the phases. """ + """Trials with any of the given phases will be included in the selection (provided that other + limitations are satisfied). + Leaving this list empty will not limit the phases.""" purposes: Optional[List[Union[str, "_models.ClinicalTrialPurpose"]]] = rest_field() - """Trials with any of the given purposes will be included in the selection (provided that other limitations are - satisfied). Leaving this list empty will not limit the purposes. """ + """Trials with any of the given purposes will be included in the selection (provided that other + limitations are satisfied). + Leaving this list empty will not limit the purposes.""" ids: Optional[List[str]] = rest_field() - """Trials with any of the given identifiers will be included in the selection (provided that other limitations - are satisfied). Leaving this list empty will not limit the trial identifiers. """ + """Trials with any of the given identifiers will be included in the selection (provided that other + limitations are satisfied). + Leaving this list empty will not limit the trial identifiers.""" sources: Optional[List[Union[str, "_models.ClinicalTrialSource"]]] = rest_field() - """Trials with any of the given sources will be included in the selection (provided that other limitations are - satisfied). Leaving this list empty will not limit the sources. """ + """Trials with any of the given sources will be included in the selection (provided that other + limitations are satisfied). + Leaving this list empty will not limit the sources.""" facility_names: Optional[List[str]] = rest_field(name="facilityNames") - """Trials with any of the given facility names will be included in the selection (provided that other limitations - are satisfied). Leaving this list empty will not limit the trial facility names. """ + """Trials with any of the given facility names will be included in the selection (provided that + other limitations are satisfied). + Leaving this list empty will not limit the trial facility names.""" facility_locations: Optional[List["_models.GeographicLocation"]] = rest_field(name="facilityLocations") - """Trials with any of the given facility locations will be included in the selection (provided that other - limitations are satisfied). Leaving this list empty will not limit the trial facility locations. """ + """Trials with any of the given facility locations will be included in the selection (provided + that other limitations are satisfied). + Leaving this list empty will not limit the trial facility locations.""" facility_areas: Optional[List["_models.GeographicArea"]] = rest_field(name="facilityAreas") - """Trials with any of the given facility area boundaries will be included in the selection (provided that other - limitations are satisfied). Leaving this list empty will not limit the trial facility area boundaries. """ + """Trials with any of the given facility area boundaries will be included in the selection + (provided that other limitations are satisfied). + Leaving this list empty will not limit the trial facility area boundaries.""" @overload def __init__( @@ -542,7 +481,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class ClinicalTrialResearchFacility(_model_base.Model): """Details of a research facility where a clinical trial is conducted. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar name: The facility's name. Required. :vartype name: str @@ -555,13 +494,13 @@ class ClinicalTrialResearchFacility(_model_base.Model): """ name: str = rest_field() - """The facility's name. Required. """ + """The facility's name. Required.""" city: Optional[str] = rest_field() - """City name. """ + """City name.""" state: Optional[str] = rest_field() - """State name. """ + """State name.""" country_or_region: str = rest_field(name="countryOrRegion") - """Country/region name. Required. """ + """Country/region name. Required.""" @overload def __init__( @@ -592,25 +531,24 @@ class ClinicalTrials(_model_base.Model): In case both are given, the resulting trial set is a union of the two sets. :ivar custom_trials: A list of clinical trials. - :vartype custom_trials: - list[~azure.healthinsights.clinicalmatching.models.ClinicalTrialDetails] + :vartype custom_trials: list[~azure.healthinsights.clinicalmatching.models.ResearchStudy] :ivar registry_filters: A list of filters, each one creating a selection of trials from a given clinical trial registry. :vartype registry_filters: list[~azure.healthinsights.clinicalmatching.models.ClinicalTrialRegistryFilter] """ - custom_trials: Optional[List["_models.ClinicalTrialDetails"]] = rest_field(name="customTrials") - """A list of clinical trials. """ + custom_trials: Optional[List["_models.ResearchStudy"]] = rest_field(name="customTrials") + """A list of clinical trials.""" registry_filters: Optional[List["_models.ClinicalTrialRegistryFilter"]] = rest_field(name="registryFilters") """A list of filters, each one creating a selection of trials from a given -clinical trial registry. """ + clinical trial registry.""" @overload def __init__( self, *, - custom_trials: Optional[List["_models.ClinicalTrialDetails"]] = None, + custom_trials: Optional[List["_models.ResearchStudy"]] = None, registry_filters: Optional[List["_models.ClinicalTrialRegistryFilter"]] = None, ): ... @@ -626,31 +564,27 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class ContactDetails(_model_base.Model): - """A person's contact details. +class CodeableConcept(Element): + """Concept - reference to a terminology or just text + Based on `FHIR CodeableConcept `_. - :ivar name: The person's name. - :vartype name: str - :ivar email: The person's email. - :vartype email: str - :ivar phone: A person's phone number. - :vartype phone: str + :ivar coding: Code defined by a terminology system. + :vartype coding: list[~azure.healthinsights.clinicalmatching.models.Coding] + :ivar text: Plain text representation of the concept. + :vartype text: str """ - name: Optional[str] = rest_field() - """The person's name. """ - email: Optional[str] = rest_field() - """The person's email. """ - phone: Optional[str] = rest_field() - """A person's phone number. """ + coding: Optional[List["_models.Coding"]] = rest_field() + """Code defined by a terminology system.""" + text: Optional[str] = rest_field() + """Plain text representation of the concept.""" @overload def __init__( self, *, - name: Optional[str] = None, - email: Optional[str] = None, - phone: Optional[str] = None, + coding: Optional[List["_models.Coding"]] = None, + text: Optional[str] = None, ): ... @@ -665,35 +599,43 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class DocumentContent(_model_base.Model): - """The content of the patient document. +class Coding(Element): + """A Coding is a representation of a defined concept using a symbol from a defined "code system". + Based on `FHIR Coding `_. - All required parameters must be populated in order to send to Azure. - - :ivar source_type: The type of the content's source. - In case the source type is 'inline', the content is given as a string (for instance, text). - In case the source type is 'reference', the content is given as a URI. Required. Known values - are: "inline" and "reference". - :vartype source_type: str or - ~azure.healthinsights.clinicalmatching.models.DocumentContentSourceType - :ivar value: The content of the document, given either inline (as a string) or as a reference - (URI). Required. - :vartype value: str + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar system: Identity of the terminology system. + :vartype system: str + :ivar version: Version of the system - if relevant. + :vartype version: str + :ivar code: Symbol in syntax defined by the system. + :vartype code: str + :ivar display: Representation defined by the system. + :vartype display: str """ - source_type: Union[str, "_models.DocumentContentSourceType"] = rest_field(name="sourceType") - """The type of the content's source. In case the source type is 'inline', the content is given as a string (for - instance, text). In case the source type is 'reference', the content is given as a URI. Required. Known values - are: \"inline\" and \"reference\". """ - value: str = rest_field() - """The content of the document, given either inline (as a string) or as a reference (URI). Required. """ + system: Optional[str] = rest_field() + """Identity of the terminology system.""" + version: Optional[str] = rest_field() + """Version of the system - if relevant.""" + code: Optional[str] = rest_field() + """Symbol in syntax defined by the system.""" + display: Optional[str] = rest_field() + """Representation defined by the system.""" @overload def __init__( self, *, - source_type: Union[str, "_models.DocumentContentSourceType"], - value: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + system: Optional[str] = None, + version: Optional[str] = None, + code: Optional[str] = None, + display: Optional[str] = None, ): ... @@ -708,45 +650,45 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class Error(_model_base.Model): - """The error object. +class Resource(_model_base.Model): + """Resource is the ancestor of DomainResource from which most resources are derived. Bundle, + Parameters, and Binary extend Resource directly. + Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. - :ivar code: One of a server-defined set of error codes. Required. - :vartype code: str - :ivar message: A human-readable representation of the error. Required. - :vartype message: str - :ivar target: The target of the error. - :vartype target: str - :ivar details: An array of details about specific errors that led to this reported error. - Required. - :vartype details: list[~azure.healthinsights.clinicalmatching.models.Error] - :ivar innererror: An object containing more specific information than the current object about - the error. - :vartype innererror: ~azure.healthinsights.clinicalmatching.models.InnerError + :ivar resource_type: The type of resource. Required. + :vartype resource_type: str + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.clinicalmatching.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str """ - code: str = rest_field() - """One of a server-defined set of error codes. Required. """ - message: str = rest_field() - """A human-readable representation of the error. Required. """ - target: Optional[str] = rest_field() - """The target of the error. """ - details: List["_models.Error"] = rest_field() - """An array of details about specific errors that led to this reported error. Required. """ - innererror: Optional["_models.InnerError"] = rest_field() - """An object containing more specific information than the current object about the error. """ + resource_type: str = rest_field(name="resourceType") + """The type of resource. Required.""" + id: Optional[str] = rest_field() + """Resource Id.""" + meta: Optional["_models.Meta"] = rest_field() + """Metadata about the resource.""" + implicit_rules: Optional[str] = rest_field(name="implicitRules") + """A set of rules under which this content was created.""" + language: Optional[str] = rest_field() + """Language of the resource content.""" @overload def __init__( self, *, - code: str, - message: str, - details: List["_models.Error"], - target: Optional[str] = None, - innererror: Optional["_models.InnerError"] = None, + resource_type: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, ): ... @@ -761,53 +703,59 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class ExtendedClinicalCodedElement(_model_base.Model): - """A piece of clinical information, expressed as a code in a clinical coding system, extended by - semantic information. +class DomainResource(Resource): + """A resource with narrative, extensions, and contained resources + Based on `FHIR DomainResource `_. - All required parameters must be populated in order to send to Azure. + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + Condition, Observation - :ivar system: The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. - :vartype system: str - :ivar code: The code within the given clinical coding system. Required. - :vartype code: str - :ivar name: The name of this coded concept in the coding system. - :vartype name: str - :ivar value: A value associated with the code within the given clinical coding system. - :vartype value: str - :ivar semantic_type: The `UMLS semantic type - `_ associated with the - coded concept. - :vartype semantic_type: str - :ivar category: The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, - Medication, Examination. - :vartype category: str + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.clinicalmatching.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.clinicalmatching.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.clinicalmatching.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar resource_type: Required. Default value is None. + :vartype resource_type: str """ - system: str = rest_field() - """The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. """ - code: str = rest_field() - """The code within the given clinical coding system. Required. """ - name: Optional[str] = rest_field() - """The name of this coded concept in the coding system. """ - value: Optional[str] = rest_field() - """A value associated with the code within the given clinical coding system. """ - semantic_type: Optional[str] = rest_field(name="semanticType") - """The `UMLS semantic type `_ associated - with the coded concept. """ - category: Optional[str] = rest_field() - """The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, Medication, Examination. """ + __mapping__: Dict[str, _model_base.Model] = {} + text: Optional["_models.Narrative"] = rest_field() + """Text summary of the resource, for human interpretation.""" + contained: Optional[List["_models.Resource"]] = rest_field() + """Contained, inline Resources.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + modifier_extension: Optional[List["_models.Extension"]] = rest_field(name="modifierExtension") + """Extensions that cannot be ignored.""" + resource_type: Literal[None] = rest_discriminator(name="resourceType") + """Required. Default value is None.""" @overload def __init__( self, *, - system: str, - code: str, - name: Optional[str] = None, - value: Optional[str] = None, - semantic_type: Optional[str] = None, - category: Optional[str] = None, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, ): ... @@ -818,38 +766,158 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) + self.resource_type: Literal[None] = None -class GeographicArea(_model_base.Model): - """A geographic area, expressed as a ``Circle`` geometry represented using a ``GeoJSON Feature`` - (see `GeoJSON spec `_ ). +class Condition(DomainResource, discriminator="Condition"): # pylint: disable=too-many-instance-attributes + """Detailed information about conditions, problems or diagnoses + Based on `FHIR Condition `_. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. - :ivar type: ``GeoJSON`` type. Required. "Feature" - :vartype type: str or ~azure.healthinsights.clinicalmatching.models.GeoJsonType - :ivar geometry: ``GeoJSON`` geometry, representing the area circle's center. Required. - :vartype geometry: ~azure.healthinsights.clinicalmatching.models.AreaGeometry - :ivar properties: ``GeoJSON`` object properties. Required. - :vartype properties: ~azure.healthinsights.clinicalmatching.models.AreaProperties + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.clinicalmatching.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.clinicalmatching.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.clinicalmatching.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "Condition". + :vartype resource_type: str + :ivar identifier: External Ids for this condition. + :vartype identifier: list[~azure.healthinsights.clinicalmatching.models.Identifier] + :ivar clinical_status: active | recurrence | relapse | inactive | remission | resolved. + :vartype clinical_status: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar verification_status: unconfirmed | provisional | differential | confirmed | refuted | + entered-in-error. + :vartype verification_status: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar category: problem-list-item | encounter-diagnosis. + :vartype category: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar severity: Subjective severity of condition. + :vartype severity: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar code: Identification of the condition, problem or diagnosis. + :vartype code: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar body_site: Anatomical location, if relevant. + :vartype body_site: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar encounter: Encounter created as part of. + :vartype encounter: ~azure.healthinsights.clinicalmatching.models.Reference + :ivar onset_date_time: Estimated or actual date, date-time, or age. + :vartype onset_date_time: str + :ivar onset_age: Estimated or actual date, date-time, or age. + :vartype onset_age: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar onset_period: Estimated or actual date, date-time, or age. + :vartype onset_period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar onset_range: Estimated or actual date, date-time, or age. + :vartype onset_range: ~azure.healthinsights.clinicalmatching.models.Range + :ivar onset_string: Estimated or actual date, date-time, or age. + :vartype onset_string: str + :ivar abatement_date_time: When in resolution/remission. + :vartype abatement_date_time: str + :ivar abatement_age: When in resolution/remission. + :vartype abatement_age: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar abatement_period: When in resolution/remission. + :vartype abatement_period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar abatement_range: When in resolution/remission. + :vartype abatement_range: ~azure.healthinsights.clinicalmatching.models.Range + :ivar abatement_string: When in resolution/remission. + :vartype abatement_string: str + :ivar recorded_date: Date record was first recorded. + :vartype recorded_date: str + :ivar stage: stge/grade, usually assessed formally. + :vartype stage: list[~azure.healthinsights.clinicalmatching.models.ConditionStage] + :ivar note: Additional information about the Condition. + :vartype note: list[~azure.healthinsights.clinicalmatching.models.Annotation] """ - type: Union[str, "_models.GeoJsonType"] = rest_field() # pylint: disable=redefined-builtin - """``GeoJSON`` type. Required. \"Feature\"""" - geometry: "_models.AreaGeometry" = rest_field() - """``GeoJSON`` geometry, representing the area circle's center. Required. """ - properties: "_models.AreaProperties" = rest_field() - """``GeoJSON`` object properties. Required. """ + resource_type: Literal["Condition"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"Condition\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """External Ids for this condition.""" + clinical_status: Optional["_models.CodeableConcept"] = rest_field(name="clinicalStatus") + """active | recurrence | relapse | inactive | remission | resolved.""" + verification_status: Optional["_models.CodeableConcept"] = rest_field(name="verificationStatus") + """unconfirmed | provisional | differential | confirmed | refuted | entered-in-error.""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """problem-list-item | encounter-diagnosis.""" + severity: Optional["_models.CodeableConcept"] = rest_field() + """Subjective severity of condition.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Identification of the condition, problem or diagnosis.""" + body_site: Optional[List["_models.CodeableConcept"]] = rest_field(name="bodySite") + """Anatomical location, if relevant.""" + encounter: Optional["_models.Reference"] = rest_field() + """Encounter created as part of.""" + onset_date_time: Optional[str] = rest_field(name="onsetDateTime") + """Estimated or actual date, date-time, or age.""" + onset_age: Optional["_models.Quantity"] = rest_field(name="onsetAge") + """Estimated or actual date, date-time, or age.""" + onset_period: Optional["_models.Period"] = rest_field(name="onsetPeriod") + """Estimated or actual date, date-time, or age.""" + onset_range: Optional["_models.Range"] = rest_field(name="onsetRange") + """Estimated or actual date, date-time, or age.""" + onset_string: Optional[str] = rest_field(name="onsetString") + """Estimated or actual date, date-time, or age.""" + abatement_date_time: Optional[str] = rest_field(name="abatementDateTime") + """When in resolution/remission.""" + abatement_age: Optional["_models.Quantity"] = rest_field(name="abatementAge") + """When in resolution/remission.""" + abatement_period: Optional["_models.Period"] = rest_field(name="abatementPeriod") + """When in resolution/remission.""" + abatement_range: Optional["_models.Range"] = rest_field(name="abatementRange") + """When in resolution/remission.""" + abatement_string: Optional[str] = rest_field(name="abatementString") + """When in resolution/remission.""" + recorded_date: Optional[str] = rest_field(name="recordedDate") + """Date record was first recorded.""" + stage: Optional[List["_models.ConditionStage"]] = rest_field() + """stge/grade, usually assessed formally.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Additional information about the Condition.""" @overload def __init__( self, *, - type: Union[str, "_models.GeoJsonType"], # pylint: disable=redefined-builtin - geometry: "_models.AreaGeometry", - properties: "_models.AreaProperties", + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + clinical_status: Optional["_models.CodeableConcept"] = None, + verification_status: Optional["_models.CodeableConcept"] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + severity: Optional["_models.CodeableConcept"] = None, + code: Optional["_models.CodeableConcept"] = None, + body_site: Optional[List["_models.CodeableConcept"]] = None, + encounter: Optional["_models.Reference"] = None, + onset_date_time: Optional[str] = None, + onset_age: Optional["_models.Quantity"] = None, + onset_period: Optional["_models.Period"] = None, + onset_range: Optional["_models.Range"] = None, + onset_string: Optional[str] = None, + abatement_date_time: Optional[str] = None, + abatement_age: Optional["_models.Quantity"] = None, + abatement_period: Optional["_models.Period"] = None, + abatement_range: Optional["_models.Range"] = None, + abatement_string: Optional[str] = None, + recorded_date: Optional[str] = None, + stage: Optional[List["_models.ConditionStage"]] = None, + note: Optional[List["_models.Annotation"]] = None, ): ... @@ -860,41 +928,32 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) + self.resource_type: Literal["Condition"] = "Condition" -class GeographicLocation(_model_base.Model): - """A location given as a combination of city, state and country/region. It could specify a city, a - state or a country/region. - In case a city is specified, either state +country/region or country/region (for - countries/regions where there are no states) should be added. - In case a state is specified (without a city), country/region should be added. - - All required parameters must be populated in order to send to Azure. +class ConditionStage(_model_base.Model): + """Stage/grade, usually assessed formally + Based on `FHIR Condition.Stage `_. - :ivar city: City name. - :vartype city: str - :ivar state: State name. - :vartype state: str - :ivar country_or_region: Country/region name. Required. - :vartype country_or_region: str + :ivar summary: Simple summary (disease specific). + :vartype summary: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar type: Kind of staging. + :vartype type: ~azure.healthinsights.clinicalmatching.models.CodeableConcept """ - city: Optional[str] = rest_field() - """City name. """ - state: Optional[str] = rest_field() - """State name. """ - country_or_region: str = rest_field(name="countryOrRegion") - """Country/region name. Required. """ + summary: Optional["_models.CodeableConcept"] = rest_field() + """Simple summary (disease specific).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Kind of staging.""" @overload def __init__( self, *, - country_or_region: str, - city: Optional[str] = None, - state: Optional[str] = None, + summary: Optional["_models.CodeableConcept"] = None, + type: Optional["_models.CodeableConcept"] = None, ): ... @@ -909,30 +968,32 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class InnerError(_model_base.Model): - """An object containing more specific information about the error. As per Microsoft One API - guidelines - - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. - - All required parameters must be populated in order to send to Azure. +class ContactDetail(Element): + """Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail). - :ivar code: One of a server-defined set of error codes. Required. - :vartype code: str - :ivar innererror: Inner error. - :vartype innererror: ~azure.healthinsights.clinicalmatching.models.InnerError + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar name: Name of an individual to contact. + :vartype name: str + :ivar telecom: Contact details for individual or organization. + :vartype telecom: list[~azure.healthinsights.clinicalmatching.models.ContactPoint] """ - code: str = rest_field() - """One of a server-defined set of error codes. Required. """ - innererror: Optional["_models.InnerError"] = rest_field() - """Inner error. """ + name: Optional[str] = rest_field() + """Name of an individual to contact.""" + telecom: Optional[List["_models.ContactPoint"]] = rest_field() + """Contact details for individual or organization.""" @overload def __init__( self, *, - code: str, - innererror: Optional["_models.InnerError"] = None, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + name: Optional[str] = None, + telecom: Optional[List["_models.ContactPoint"]] = None, ): ... @@ -947,57 +1008,1533 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class PatientDocument(_model_base.Model): - """A clinical document related to a patient. Document here is in the wide sense - not just a text - document (note). - - All required parameters must be populated in order to send to Azure. +class ContactDetails(_model_base.Model): + """A person's contact details. - :ivar type: The type of the patient document, such as 'note' (text document) or 'fhirBundle' - (FHIR JSON document). Required. Known values are: "note", "fhirBundle", "dicom", and - "genomicSequencing". - :vartype type: str or ~azure.healthinsights.clinicalmatching.models.DocumentType - :ivar clinical_type: The type of the clinical document. Known values are: "consultation", - "dischargeSummary", "historyAndPhysical", "procedure", "progress", "imaging", "laboratory", and - "pathology". - :vartype clinical_type: str or - ~azure.healthinsights.clinicalmatching.models.ClinicalDocumentType - :ivar id: A given identifier for the document. Has to be unique across all documents for a - single patient. Required. - :vartype id: str - :ivar language: A 2 letter ISO 639-1 representation of the language of the document. - :vartype language: str - :ivar created_date_time: The date and time when the document was created. - :vartype created_date_time: ~datetime.datetime - :ivar content: The content of the patient document. Required. - :vartype content: ~azure.healthinsights.clinicalmatching.models.DocumentContent + :ivar name: The person's name. + :vartype name: str + :ivar email: The person's email. + :vartype email: str + :ivar phone: A person's phone number. + :vartype phone: str """ - type: Union[str, "_models.DocumentType"] = rest_field() # pylint: disable=redefined-builtin - """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document). - Required. Known values are: \"note\", \"fhirBundle\", \"dicom\", and \"genomicSequencing\". """ - clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = rest_field(name="clinicalType") - """The type of the clinical document. Known values are: \"consultation\", \"dischargeSummary\", - \"historyAndPhysical\", \"procedure\", \"progress\", \"imaging\", \"laboratory\", and \"pathology\". """ - id: str = rest_field() - """A given identifier for the document. Has to be unique across all documents for a single patient. Required. """ - language: Optional[str] = rest_field() - """A 2 letter ISO 639-1 representation of the language of the document. """ - created_date_time: Optional[datetime.datetime] = rest_field(name="createdDateTime") - """The date and time when the document was created. """ - content: "_models.DocumentContent" = rest_field() - """The content of the patient document. Required. """ + name: Optional[str] = rest_field() + """The person's name.""" + email: Optional[str] = rest_field() + """The person's email.""" + phone: Optional[str] = rest_field() + """A person's phone number.""" @overload def __init__( self, *, - type: Union[str, "_models.DocumentType"], # pylint: disable=redefined-builtin - id: str, # pylint: disable=redefined-builtin + name: Optional[str] = None, + email: Optional[str] = None, + phone: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ContactPoint(_model_base.Model): + """Details for all kinds of technology mediated contact points for a person or organization, + including telephone, email, etc. + See https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint. + + :ivar system: phone | fax | email | pager | url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and "other". + :vartype system: str or ~azure.healthinsights.clinicalmatching.models.ContactPointSystem + :ivar value: The actual contact point details. + :vartype value: str + :ivar use: home | work | temp | old | mobile - purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + :vartype use: str or ~azure.healthinsights.clinicalmatching.models.ContactPointUse + :ivar rank: Specify preferred order of use (1 = highest). + :vartype rank: int + :ivar period: Time period when the contact point was/is in use. + :vartype period: ~azure.healthinsights.clinicalmatching.models.Period + """ + + system: Optional[Union[str, "_models.ContactPointSystem"]] = rest_field() + """phone | fax | email | pager | url | sms | other. Known values are: \"phone\", \"fax\", + \"email\", \"pager\", \"url\", \"sms\", and \"other\".""" + value: Optional[str] = rest_field() + """The actual contact point details.""" + use: Optional[Union[str, "_models.ContactPointUse"]] = rest_field() + """home | work | temp | old | mobile - purpose of this contact point. Known values are: \"home\", + \"work\", \"temp\", \"old\", and \"mobile\".""" + rank: Optional[int] = rest_field() + """Specify preferred order of use (1 = highest).""" + period: Optional["_models.Period"] = rest_field() + """Time period when the contact point was/is in use.""" + + @overload + def __init__( + self, + *, + system: Optional[Union[str, "_models.ContactPointSystem"]] = None, + value: Optional[str] = None, + use: Optional[Union[str, "_models.ContactPointUse"]] = None, + rank: Optional[int] = None, + period: Optional["_models.Period"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAdministrativeMetadata(_model_base.Model): + """Document administrative metadata. + + :ivar ordered_procedures: List of procedure information associated with the document. + :vartype ordered_procedures: + list[~azure.healthinsights.clinicalmatching.models.OrderedProcedure] + :ivar encounter_id: Reference to the encounter associated with the document. + :vartype encounter_id: str + """ + + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = rest_field(name="orderedProcedures") + """List of procedure information associated with the document.""" + encounter_id: Optional[str] = rest_field(name="encounterId") + """Reference to the encounter associated with the document.""" + + @overload + def __init__( + self, + *, + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = None, + encounter_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAuthor(_model_base.Model): + """Document author. + + :ivar id: author id. + :vartype id: str + :ivar full_name: Text representation of the full name. + :vartype full_name: str + """ + + id: Optional[str] = rest_field() + """author id.""" + full_name: Optional[str] = rest_field(name="fullName") + """Text representation of the full name.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + full_name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentContent(_model_base.Model): + """The content of the patient document. + + All required parameters must be populated in order to send to server. + + :ivar source_type: The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: "inline" and "reference". + :vartype source_type: str or + ~azure.healthinsights.clinicalmatching.models.DocumentContentSourceType + :ivar value: The content of the document, given either inline (as a string) or as a reference + (URI). Required. + :vartype value: str + """ + + source_type: Union[str, "_models.DocumentContentSourceType"] = rest_field(name="sourceType") + """The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: \"inline\" and \"reference\".""" + value: str = rest_field() + """The content of the document, given either inline (as a string) or as a reference (URI). + Required.""" + + @overload + def __init__( + self, + *, + source_type: Union[str, "_models.DocumentContentSourceType"], + value: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Encounter(_model_base.Model): + """visit/encounter information. + + All required parameters must be populated in order to send to server. + + :ivar id: The id of the visit. Required. + :vartype id: str + :ivar period: Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end + to indicate the discharge time. + :vartype period: ~azure.healthinsights.clinicalmatching.models.TimePeriod + :ivar class_property: The class of the encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + :vartype class_property: str or ~azure.healthinsights.clinicalmatching.models.EncounterClass + """ + + id: str = rest_field() + """The id of the visit. Required.""" + period: Optional["_models.TimePeriod"] = rest_field() + """Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to + indicate the discharge time.""" + class_property: Optional[Union[str, "_models.EncounterClass"]] = rest_field(name="class") + """The class of the encounter. Known values are: \"inpatient\", \"ambulatory\", \"observation\", + \"emergency\", \"virtual\", and \"healthHome\".""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + period: Optional["_models.TimePeriod"] = None, + class_property: Optional[Union[str, "_models.EncounterClass"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Error(_model_base.Model): + """The error object. + + All required parameters must be populated in order to send to server. + + :ivar code: One of a server-defined set of error codes. Required. + :vartype code: str + :ivar message: A human-readable representation of the error. Required. + :vartype message: str + :ivar target: The target of the error. + :vartype target: str + :ivar details: An array of details about specific errors that led to this reported error. + :vartype details: list[~azure.healthinsights.clinicalmatching.models.Error] + :ivar innererror: An object containing more specific information than the current object about + the error. + :vartype innererror: ~azure.healthinsights.clinicalmatching.models.InnerError + """ + + code: str = rest_field() + """One of a server-defined set of error codes. Required.""" + message: str = rest_field() + """A human-readable representation of the error. Required.""" + target: Optional[str] = rest_field() + """The target of the error.""" + details: Optional[List["_models.Error"]] = rest_field() + """An array of details about specific errors that led to this reported error.""" + innererror: Optional["_models.InnerError"] = rest_field() + """An object containing more specific information than the current object about the error.""" + + @overload + def __init__( + self, + *, + code: str, + message: str, + target: Optional[str] = None, + details: Optional[List["_models.Error"]] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ExtendedClinicalCodedElement(_model_base.Model): + """A piece of clinical information, expressed as a code in a clinical coding system, extended by + semantic information. + + All required parameters must be populated in order to send to server. + + :ivar system: The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + :vartype system: str + :ivar code: The code within the given clinical coding system. Required. + :vartype code: str + :ivar name: The name of this coded concept in the coding system. + :vartype name: str + :ivar value: A value associated with the code within the given clinical coding system. + :vartype value: str + :ivar semantic_type: The `UMLS semantic type + `_ associated with the + coded concept. + :vartype semantic_type: str + :ivar category: The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, + Medication, Examination. + :vartype category: str + """ + + system: str = rest_field() + """The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required.""" + code: str = rest_field() + """The code within the given clinical coding system. Required.""" + name: Optional[str] = rest_field() + """The name of this coded concept in the coding system.""" + value: Optional[str] = rest_field() + """A value associated with the code within the given clinical coding system.""" + semantic_type: Optional[str] = rest_field(name="semanticType") + """The `UMLS semantic type + `_ associated with the + coded concept.""" + category: Optional[str] = rest_field() + """The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, Medication, + Examination.""" + + @overload + def __init__( + self, + *, + system: str, + code: str, + name: Optional[str] = None, + value: Optional[str] = None, + semantic_type: Optional[str] = None, + category: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Extension(Element): # pylint: disable=too-many-instance-attributes + """Base for all elements + Based on `FHIR Element `_. + + All required parameters must be populated in order to send to server. + + :ivar url: Source of the definition for the extension code - a logical name or a URL. Required. + :vartype url: str + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.clinicalmatching.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.clinicalmatching.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.clinicalmatching.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.clinicalmatching.models.Reference + """ + + url: str = rest_field() + """Source of the definition for the extension code - a logical name or a URL. Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + + @overload + def __init__( + self, + *, + url: str, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class GeographicArea(_model_base.Model): + """A geographic area, expressed as a ``Circle`` geometry represented using a ``GeoJSON Feature`` + (see `GeoJSON spec `_\ ). + + All required parameters must be populated in order to send to server. + + :ivar type: ``GeoJSON`` type. Required. "Feature" + :vartype type: str or ~azure.healthinsights.clinicalmatching.models.GeoJsonType + :ivar geometry: ``GeoJSON`` geometry, representing the area circle's center. Required. + :vartype geometry: ~azure.healthinsights.clinicalmatching.models.AreaGeometry + :ivar properties: ``GeoJSON`` object properties. Required. + :vartype properties: ~azure.healthinsights.clinicalmatching.models.AreaProperties + """ + + type: Union[str, "_models.GeoJsonType"] = rest_field() + """``GeoJSON`` type. Required. \"Feature\"""" + geometry: "_models.AreaGeometry" = rest_field() + """``GeoJSON`` geometry, representing the area circle's center. Required.""" + properties: "_models.AreaProperties" = rest_field() + """``GeoJSON`` object properties. Required.""" + + @overload + def __init__( + self, + *, + type: Union[str, "_models.GeoJsonType"], + geometry: "_models.AreaGeometry", + properties: "_models.AreaProperties", + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class GeographicLocation(_model_base.Model): + """A location given as a combination of city, state and country/region. It could specify a city, a + state or a country/region. + In case a city is specified, either state +country/region or country/region (for + countries/regions where there are no states) should be added. + In case a state is specified (without a city), country/region should be added. + + All required parameters must be populated in order to send to server. + + :ivar city: City name. + :vartype city: str + :ivar state: State name. + :vartype state: str + :ivar country_or_region: Country/region name. Required. + :vartype country_or_region: str + """ + + city: Optional[str] = rest_field() + """City name.""" + state: Optional[str] = rest_field() + """State name.""" + country_or_region: str = rest_field(name="countryOrRegion") + """Country/region name. Required.""" + + @overload + def __init__( + self, + *, + country_or_region: str, + city: Optional[str] = None, + state: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class HealthInsightsOperationStatus(_model_base.Model): + """Provides status details for long running operations. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: The unique ID of the operation. Required. + :vartype id: str + :ivar status: The status of the operation. Required. Known values are: "notStarted", "running", + "succeeded", "failed", and "canceled". + :vartype status: str or ~azure.healthinsights.clinicalmatching.models.JobStatus + :ivar created_date_time: The date and time when the processing job was created. + :vartype created_date_time: ~datetime.datetime + :ivar expiration_date_time: The date and time when the processing job is set to expire. + :vartype expiration_date_time: ~datetime.datetime + :ivar last_update_date_time: The date and time when the processing job was last updated. + :vartype last_update_date_time: ~datetime.datetime + :ivar error: Error object that describes the error when status is "Failed". + :vartype error: ~azure.healthinsights.clinicalmatching.models.Error + :ivar result: The result of the operation. + :vartype result: ~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult + """ + + id: str = rest_field(visibility=["read"]) + """The unique ID of the operation. Required.""" + status: Union[str, "_models.JobStatus"] = rest_field(visibility=["read"]) + """The status of the operation. Required. Known values are: \"notStarted\", \"running\", + \"succeeded\", \"failed\", and \"canceled\".""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was created.""" + expiration_date_time: Optional[datetime.datetime] = rest_field( + name="expirationDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job is set to expire.""" + last_update_date_time: Optional[datetime.datetime] = rest_field( + name="lastUpdateDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was last updated.""" + error: Optional["_models.Error"] = rest_field() + """Error object that describes the error when status is \"Failed\".""" + result: Optional["_models.TrialMatcherInferenceResult"] = rest_field() + """The result of the operation.""" + + @overload + def __init__( + self, + *, + error: Optional["_models.Error"] = None, + result: Optional["_models.TrialMatcherInferenceResult"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Identifier(Element): + """An identifier intended for computation + Based on `FHIR Identifier `_. + + :ivar use: usual | official | temp | secondary | old (If known). + :vartype use: str + :ivar type: Description of identifier. + :vartype type: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar system: The namespace for the identifier value. + :vartype system: str + :ivar value: The value that is unique. + :vartype value: str + :ivar period: Time period when id is/was valid for use. + :vartype period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar assigner: Organization that issued id (may be just text). + :vartype assigner: ~azure.healthinsights.clinicalmatching.models.Reference + """ + + use: Optional[str] = rest_field() + """usual | official | temp | secondary | old (If known).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Description of identifier.""" + system: Optional[str] = rest_field() + """The namespace for the identifier value.""" + value: Optional[str] = rest_field() + """The value that is unique.""" + period: Optional["_models.Period"] = rest_field() + """Time period when id is/was valid for use.""" + assigner: Optional["_models.Reference"] = rest_field() + """Organization that issued id (may be just text).""" + + @overload + def __init__( + self, + *, + use: Optional[str] = None, + type: Optional["_models.CodeableConcept"] = None, + system: Optional[str] = None, + value: Optional[str] = None, + period: Optional["_models.Period"] = None, + assigner: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class InnerError(_model_base.Model): + """An object containing more specific information about the error. As per Microsoft One API + guidelines - + https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + + :ivar code: One of a server-defined set of error codes. + :vartype code: str + :ivar innererror: Inner error. + :vartype innererror: ~azure.healthinsights.clinicalmatching.models.InnerError + """ + + code: Optional[str] = rest_field() + """One of a server-defined set of error codes.""" + innererror: Optional["_models.InnerError"] = rest_field() + """Inner error.""" + + @overload + def __init__( + self, + *, + code: Optional[str] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Meta(_model_base.Model): + """Metadata about a resource + Based on `FHIR Meta `_. + + :ivar version_id: The version specific identifier, as it appears in the version portion of the + URL. This value changes when the resource is created, updated, or deleted. + :vartype version_id: str + :ivar last_updated: When the resource last changed - e.g. when the version changed. + :vartype last_updated: str + :ivar source: A uri that identifies the source system of the resource. This provides a minimal + amount of Provenance information that can be used to track or differentiate the source of + information in the resource. The source may identify another FHIR server, document, message, + database, etc. + :vartype source: str + :ivar profile: A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_. + :vartype profile: list[str] + :ivar security: Security labels applied to this resource. These tags connect specific resources + to the overall security policy and infrastructure. + :vartype security: list[~azure.healthinsights.clinicalmatching.models.Coding] + :ivar tag: Tags applied to this resource. Tags are intended to be used to identify and relate + resources to process and workflow, and applications are not required to consider the tags when + interpreting the meaning of a resource. + :vartype tag: list[~azure.healthinsights.clinicalmatching.models.Coding] + """ + + version_id: Optional[str] = rest_field(name="versionId") + """The version specific identifier, as it appears in the version portion of the URL. This value + changes when the resource is created, updated, or deleted.""" + last_updated: Optional[str] = rest_field(name="lastUpdated") + """When the resource last changed - e.g. when the version changed.""" + source: Optional[str] = rest_field() + """A uri that identifies the source system of the resource. This provides a minimal amount of + Provenance information that can be used to track or differentiate the source of information in + the resource. The source may identify another FHIR server, document, message, database, etc.""" + profile: Optional[List[str]] = rest_field() + """A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_.""" + security: Optional[List["_models.Coding"]] = rest_field() + """Security labels applied to this resource. These tags connect specific resources to the overall + security policy and infrastructure.""" + tag: Optional[List["_models.Coding"]] = rest_field() + """Tags applied to this resource. Tags are intended to be used to identify and relate resources to + process and workflow, and applications are not required to consider the tags when interpreting + the meaning of a resource.""" + + @overload + def __init__( + self, + *, + version_id: Optional[str] = None, + last_updated: Optional[str] = None, + source: Optional[str] = None, + profile: Optional[List[str]] = None, + security: Optional[List["_models.Coding"]] = None, + tag: Optional[List["_models.Coding"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Narrative(Element): + """Any resource that is a `DomainResource `_ may + include a human-readable narrative that contains a summary of the resource and may be used to + represent the content of the resource to a human. + Based on `FHIR Narrative `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar status: generated, extensions, additional, empty. Required. + :vartype status: str + :ivar div: xhtml. Required. + :vartype div: str + """ + + status: str = rest_field() + """generated, extensions, additional, empty. Required.""" + div: str = rest_field() + """xhtml. Required.""" + + @overload + def __init__( + self, + *, + status: str, + div: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Observation(DomainResource, discriminator="Observation"): # pylint: disable=too-many-instance-attributes + """Detailed information about observations + Based on `FHIR Observation `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.clinicalmatching.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.clinicalmatching.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.clinicalmatching.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "Observation". + :vartype resource_type: str + :ivar identifier: Business Identifier for observation. + :vartype identifier: list[~azure.healthinsights.clinicalmatching.models.Identifier] + :ivar status: registered | preliminary | final | amended +. Required. Known values are: + "registered", "preliminary", "final", "amended", "corrected", "cancelled", "entered-in-error", + and "unknown". + :vartype status: str or ~azure.healthinsights.clinicalmatching.models.ObservationStatusCodeType + :ivar category: Classification of type of observation. + :vartype category: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar code: Type of observation (code / type). Required. + :vartype code: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar subject: Who and/or what the observation is about. + :vartype subject: ~azure.healthinsights.clinicalmatching.models.Reference + :ivar encounter: Healthcare event during which this observation is made. + :vartype encounter: ~azure.healthinsights.clinicalmatching.models.Reference + :ivar effective_date_time: Clinically relevant time/time-period for observation. + :vartype effective_date_time: str + :ivar effective_period: Clinically relevant time/time-period for observation. + :vartype effective_period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar effective_instant: Clinically relevant time/time-period for observation. + :vartype effective_instant: str + :ivar issued: Date/Time this version was made available. + :vartype issued: str + :ivar value_quantity: Actual result. + :vartype value_quantity: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar value_codeable_concept: Actual result. + :vartype value_codeable_concept: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar value_string: Actual result. + :vartype value_string: str + :ivar value_boolean: Actual result. + :vartype value_boolean: bool + :ivar value_integer: Actual result. + :vartype value_integer: int + :ivar value_range: Actual result. + :vartype value_range: ~azure.healthinsights.clinicalmatching.models.Range + :ivar value_ratio: Actual result. + :vartype value_ratio: ~azure.healthinsights.clinicalmatching.models.Ratio + :ivar value_sampled_data: Actual result. + :vartype value_sampled_data: ~azure.healthinsights.clinicalmatching.models.SampledData + :ivar value_time: Actual result. + :vartype value_time: ~datetime.time + :ivar value_date_time: Actual result. + :vartype value_date_time: str + :ivar value_period: Actual result. + :vartype value_period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar data_absent_reason: Why the result is missing. + :vartype data_absent_reason: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar interpretation: High, low, normal, etc. + :vartype interpretation: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar note: Comments about the observation. + :vartype note: list[~azure.healthinsights.clinicalmatching.models.Annotation] + :ivar body_site: Observed body part. + :vartype body_site: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar method: How it was done. + :vartype method: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar reference_range: Provides guide for interpretation. + :vartype reference_range: + list[~azure.healthinsights.clinicalmatching.models.ObservationReferenceRange] + :ivar has_member: Related resource that belongs to the Observation group. + :vartype has_member: list[~azure.healthinsights.clinicalmatching.models.Reference] + :ivar derived_from: Related measurements the observation is made from. + :vartype derived_from: list[~azure.healthinsights.clinicalmatching.models.Reference] + :ivar component: Component results. + :vartype component: list[~azure.healthinsights.clinicalmatching.models.ObservationComponent] + """ + + resource_type: Literal["Observation"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"Observation\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """Business Identifier for observation.""" + status: Union[str, "_models.ObservationStatusCodeType"] = rest_field() + """registered | preliminary | final | amended +. Required. Known values are: \"registered\", + \"preliminary\", \"final\", \"amended\", \"corrected\", \"cancelled\", \"entered-in-error\", + and \"unknown\".""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """Classification of type of observation.""" + code: "_models.CodeableConcept" = rest_field() + """Type of observation (code / type). Required.""" + subject: Optional["_models.Reference"] = rest_field() + """Who and/or what the observation is about.""" + encounter: Optional["_models.Reference"] = rest_field() + """Healthcare event during which this observation is made.""" + effective_date_time: Optional[str] = rest_field(name="effectiveDateTime") + """Clinically relevant time/time-period for observation.""" + effective_period: Optional["_models.Period"] = rest_field(name="effectivePeriod") + """Clinically relevant time/time-period for observation.""" + effective_instant: Optional[str] = rest_field(name="effectiveInstant") + """Clinically relevant time/time-period for observation.""" + issued: Optional[str] = rest_field() + """Date/Time this version was made available.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Actual result.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Actual result.""" + value_string: Optional[str] = rest_field(name="valueString") + """Actual result.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Actual result.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Actual result.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Actual result.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Actual result.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Actual result.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Actual result.""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Actual result.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Actual result.""" + data_absent_reason: Optional["_models.CodeableConcept"] = rest_field(name="dataAbsentReason") + """Why the result is missing.""" + interpretation: Optional[List["_models.CodeableConcept"]] = rest_field() + """High, low, normal, etc.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Comments about the observation.""" + body_site: Optional["_models.CodeableConcept"] = rest_field(name="bodySite") + """Observed body part.""" + method: Optional["_models.CodeableConcept"] = rest_field() + """How it was done.""" + reference_range: Optional[List["_models.ObservationReferenceRange"]] = rest_field(name="referenceRange") + """Provides guide for interpretation.""" + has_member: Optional[List["_models.Reference"]] = rest_field(name="hasMember") + """Related resource that belongs to the Observation group.""" + derived_from: Optional[List["_models.Reference"]] = rest_field(name="derivedFrom") + """Related measurements the observation is made from.""" + component: Optional[List["_models.ObservationComponent"]] = rest_field() + """Component results.""" + + @overload + def __init__( + self, + *, + status: Union[str, "_models.ObservationStatusCodeType"], + code: "_models.CodeableConcept", + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + subject: Optional["_models.Reference"] = None, + encounter: Optional["_models.Reference"] = None, + effective_date_time: Optional[str] = None, + effective_period: Optional["_models.Period"] = None, + effective_instant: Optional[str] = None, + issued: Optional[str] = None, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + data_absent_reason: Optional["_models.CodeableConcept"] = None, + interpretation: Optional[List["_models.CodeableConcept"]] = None, + note: Optional[List["_models.Annotation"]] = None, + body_site: Optional["_models.CodeableConcept"] = None, + method: Optional["_models.CodeableConcept"] = None, + reference_range: Optional[List["_models.ObservationReferenceRange"]] = None, + has_member: Optional[List["_models.Reference"]] = None, + derived_from: Optional[List["_models.Reference"]] = None, + component: Optional[List["_models.ObservationComponent"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.resource_type: Literal["Observation"] = "Observation" + + +class ObservationComponent(Element): # pylint: disable=too-many-instance-attributes + """Component results + Based on `FHIR Observation.component `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar code: Type of component observation (code / type). Required. + :vartype code: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.clinicalmatching.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.clinicalmatching.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.clinicalmatching.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.clinicalmatching.models.Reference + :ivar data_absent_reason: Why the component result is missing. + :vartype data_absent_reason: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar interpretation: High, low, normal, etc. + :vartype interpretation: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar reference_range: Provides guide for interpretation of component result. + :vartype reference_range: + list[~azure.healthinsights.clinicalmatching.models.ObservationReferenceRange] + """ + + code: "_models.CodeableConcept" = rest_field() + """Type of component observation (code / type). Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + data_absent_reason: Optional["_models.CodeableConcept"] = rest_field(name="dataAbsentReason") + """Why the component result is missing.""" + interpretation: Optional[List["_models.CodeableConcept"]] = rest_field() + """High, low, normal, etc.""" + reference_range: Optional[List["_models.ObservationReferenceRange"]] = rest_field(name="referenceRange") + """Provides guide for interpretation of component result.""" + + @overload + def __init__( + self, + *, + code: "_models.CodeableConcept", + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + data_absent_reason: Optional["_models.CodeableConcept"] = None, + interpretation: Optional[List["_models.CodeableConcept"]] = None, + reference_range: Optional[List["_models.ObservationReferenceRange"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ObservationReferenceRange(_model_base.Model): + """Provides guide for interpretation of component result + Based on `FHIR Observation.referenceRange `_. + + :ivar low: Low Range, if relevant. + :vartype low: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar high: High Range, if relevant. + :vartype high: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar type: Reference range qualifier. + :vartype type: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar applies_to: Reference range population. + :vartype applies_to: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar age: Applicable age range, if relevant. + :vartype age: ~azure.healthinsights.clinicalmatching.models.Range + :ivar text: Text based reference range in an observation. + :vartype text: str + """ + + low: Optional["_models.Quantity"] = rest_field() + """Low Range, if relevant.""" + high: Optional["_models.Quantity"] = rest_field() + """High Range, if relevant.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Reference range qualifier.""" + applies_to: Optional[List["_models.CodeableConcept"]] = rest_field(name="appliesTo") + """Reference range population.""" + age: Optional["_models.Range"] = rest_field() + """Applicable age range, if relevant.""" + text: Optional[str] = rest_field() + """Text based reference range in an observation.""" + + @overload + def __init__( + self, + *, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, + type: Optional["_models.CodeableConcept"] = None, + applies_to: Optional[List["_models.CodeableConcept"]] = None, + age: Optional["_models.Range"] = None, + text: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OrderedProcedure(_model_base.Model): + """Procedure information. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar code: Procedure code. + :vartype code: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar description: Procedure description. + :vartype description: str + """ + + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Procedure code.""" + description: Optional[str] = rest_field() + """Procedure description.""" + + @overload + def __init__( + self, + *, + extension: Optional[List["_models.Extension"]] = None, + code: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientDetails(_model_base.Model): + """Patient structured information, including demographics and known structured clinical + information. + + :ivar sex: The patient's sex. Known values are: "female", "male", and "unspecified". + :vartype sex: str or ~azure.healthinsights.clinicalmatching.models.PatientSex + :ivar birth_date: The patient's date of birth. + :vartype birth_date: ~datetime.date + :ivar clinical_info: Known clinical information for the patient, structured. + :vartype clinical_info: list[~azure.healthinsights.clinicalmatching.models.Resource] + """ + + sex: Optional[Union[str, "_models.PatientSex"]] = rest_field() + """The patient's sex. Known values are: \"female\", \"male\", and \"unspecified\".""" + birth_date: Optional[datetime.date] = rest_field(name="birthDate") + """The patient's date of birth.""" + clinical_info: Optional[List["_models.Resource"]] = rest_field(name="clinicalInfo") + """Known clinical information for the patient, structured.""" + + @overload + def __init__( + self, + *, + sex: Optional[Union[str, "_models.PatientSex"]] = None, + birth_date: Optional[datetime.date] = None, + clinical_info: Optional[List["_models.Resource"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientDocument(_model_base.Model): + """A clinical document related to a patient. Document here is in the wide sense - not just a text + document (note). + + All required parameters must be populated in order to send to server. + + :ivar type: The type of the patient document, such as 'note' (text document) or 'fhirBundle' + (FHIR JSON document). Required. Known values are: "note", "fhirBundle", "dicom", and + "genomicSequencing". + :vartype type: str or ~azure.healthinsights.clinicalmatching.models.DocumentType + :ivar clinical_type: The type of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", "procedure", "progress", + "laboratory", and "pathologyReport". + :vartype clinical_type: str or + ~azure.healthinsights.clinicalmatching.models.ClinicalDocumentType + :ivar id: A given identifier for the document. Has to be unique across all documents for a + single patient. Required. + :vartype id: str + :ivar language: A 2 letter ISO 639-1 representation of the language of the document. + :vartype language: str + :ivar created_date_time: The date and time when the document was created. + :vartype created_date_time: ~datetime.datetime + :ivar authors: Document author(s). + :vartype authors: list[~azure.healthinsights.clinicalmatching.models.DocumentAuthor] + :ivar specialty_type: specialty type the document. Known values are: "pathology" and + "radiology". + :vartype specialty_type: str or ~azure.healthinsights.clinicalmatching.models.SpecialtyType + :ivar administrative_metadata: Administrative metadata for the document. + :vartype administrative_metadata: + ~azure.healthinsights.clinicalmatching.models.DocumentAdministrativeMetadata + :ivar content: The content of the patient document. Required. + :vartype content: ~azure.healthinsights.clinicalmatching.models.DocumentContent + """ + + type: Union[str, "_models.DocumentType"] = rest_field() + """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON + document). Required. Known values are: \"note\", \"fhirBundle\", \"dicom\", and + \"genomicSequencing\".""" + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = rest_field(name="clinicalType") + """The type of the clinical document. Known values are: \"consultation\", \"dischargeSummary\", + \"historyAndPhysical\", \"radiologyReport\", \"procedure\", \"progress\", \"laboratory\", and + \"pathologyReport\".""" + id: str = rest_field() + """A given identifier for the document. Has to be unique across all documents for a single + patient. Required.""" + language: Optional[str] = rest_field() + """A 2 letter ISO 639-1 representation of the language of the document.""" + created_date_time: Optional[datetime.datetime] = rest_field(name="createdDateTime", format="rfc3339") + """The date and time when the document was created.""" + authors: Optional[List["_models.DocumentAuthor"]] = rest_field() + """Document author(s).""" + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = rest_field(name="specialtyType") + """specialty type the document. Known values are: \"pathology\" and \"radiology\".""" + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = rest_field( + name="administrativeMetadata" + ) + """Administrative metadata for the document.""" + content: "_models.DocumentContent" = rest_field() + """The content of the patient document. Required.""" + + @overload + def __init__( + self, + *, + type: Union[str, "_models.DocumentType"], + id: str, # pylint: disable=redefined-builtin content: "_models.DocumentContent", clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = None, language: Optional[str] = None, created_date_time: Optional[datetime.datetime] = None, + authors: Optional[List["_models.DocumentAuthor"]] = None, + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = None, + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientRecord(_model_base.Model): + """A patient record, including their clinical information and data. + + All required parameters must be populated in order to send to server. + + :ivar id: A given identifier for the patient. Has to be unique across all patients in a single + request. Required. + :vartype id: str + :ivar info: Patient structured information, including demographics and known structured + clinical information. + :vartype info: ~azure.healthinsights.clinicalmatching.models.PatientDetails + :ivar encounters: Patient encounters/visits. + :vartype encounters: list[~azure.healthinsights.clinicalmatching.models.Encounter] + :ivar patient_documents: Patient unstructured clinical data, given as documents. + :vartype patient_documents: list[~azure.healthinsights.clinicalmatching.models.PatientDocument] + """ + + id: str = rest_field() + """A given identifier for the patient. Has to be unique across all patients in a single request. + Required.""" + info: Optional["_models.PatientDetails"] = rest_field() + """Patient structured information, including demographics and known structured clinical + information.""" + encounters: Optional[List["_models.Encounter"]] = rest_field() + """Patient encounters/visits.""" + patient_documents: Optional[List["_models.PatientDocument"]] = rest_field(name="patientDocuments") + """Patient unstructured clinical data, given as documents.""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + info: Optional["_models.PatientDetails"] = None, + encounters: Optional[List["_models.Encounter"]] = None, + patient_documents: Optional[List["_models.PatientDocument"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Period(Element): + """A time period defined by a start and end date and optionally time + Based on `FHIR Period `_. + + :ivar start: Starting time with inclusive boundary. + :vartype start: str + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: str + """ + + start: Optional[str] = rest_field() + """Starting time with inclusive boundary.""" + end: Optional[str] = rest_field() + """End time with inclusive boundary, if not ongoing.""" + + @overload + def __init__( + self, + *, + start: Optional[str] = None, + end: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Quantity(Element): + """A measured or measurable amount + Based on `FHIR Quantity `_. + + :ivar value: Numerical value (with implicit precision). + :vartype value: float + :ivar comparator: < | <= | >= | > - how to understand the value. + :vartype comparator: str + :ivar unit: Unit representation. + :vartype unit: str + :ivar system: System that defines coded unit form. + :vartype system: str + :ivar code: Coded form of the unit. + :vartype code: str + """ + + value: Optional[float] = rest_field() + """Numerical value (with implicit precision).""" + comparator: Optional[str] = rest_field() + """< | <= | >= | > - how to understand the value.""" + unit: Optional[str] = rest_field() + """Unit representation.""" + system: Optional[str] = rest_field() + """System that defines coded unit form.""" + code: Optional[str] = rest_field() + """Coded form of the unit.""" + + @overload + def __init__( + self, + *, + value: Optional[float] = None, + comparator: Optional[str] = None, + unit: Optional[str] = None, + system: Optional[str] = None, + code: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Range(Element): + """A set of ordered Quantities defined by a low and high limit + Based on `FHIR Range `_. + + :ivar low: Low limit. + :vartype low: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar high: High limit. + :vartype high: ~azure.healthinsights.clinicalmatching.models.Quantity + """ + + low: Optional["_models.Quantity"] = rest_field() + """Low limit.""" + high: Optional["_models.Quantity"] = rest_field() + """High limit.""" + + @overload + def __init__( + self, + *, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, ): ... @@ -1012,33 +2549,27 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class PatientInfo(_model_base.Model): - """Patient structured information, including demographics and known structured clinical - information. +class Ratio(Element): + """A ratio of two Quantity values - a numerator and a denominator + Based on `FHIR Ratio `_. - :ivar sex: The patient's sex. Known values are: "female", "male", and "unspecified". - :vartype sex: str or ~azure.healthinsights.clinicalmatching.models.PatientInfoSex - :ivar birth_date: The patient's date of birth. - :vartype birth_date: ~datetime.date - :ivar clinical_info: Known clinical information for the patient, structured. - :vartype clinical_info: - list[~azure.healthinsights.clinicalmatching.models.ClinicalCodedElement] + :ivar numerator: Numerator value. + :vartype numerator: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar denominator: Denominator value. + :vartype denominator: ~azure.healthinsights.clinicalmatching.models.Quantity """ - sex: Optional[Union[str, "_models.PatientInfoSex"]] = rest_field() - """The patient's sex. Known values are: \"female\", \"male\", and \"unspecified\".""" - birth_date: Optional[datetime.date] = rest_field(name="birthDate") - """The patient's date of birth. """ - clinical_info: Optional[List["_models.ClinicalCodedElement"]] = rest_field(name="clinicalInfo") - """Known clinical information for the patient, structured. """ + numerator: Optional["_models.Quantity"] = rest_field() + """Numerator value.""" + denominator: Optional["_models.Quantity"] = rest_field() + """Denominator value.""" @overload def __init__( self, *, - sex: Optional[Union[str, "_models.PatientInfoSex"]] = None, - birth_date: Optional[datetime.date] = None, - clinical_info: Optional[List["_models.ClinicalCodedElement"]] = None, + numerator: Optional["_models.Quantity"] = None, + denominator: Optional["_models.Quantity"] = None, ): ... @@ -1053,35 +2584,402 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class PatientRecord(_model_base.Model): - """A patient record, including their clinical information and data. +class Reference(Element): + """A reference from one resource to another + Based on `FHIR Reference `_. + + :ivar reference: Literal reference, Relative, internal or absolute URL. + :vartype reference: str + :ivar type: Type the reference refers to (e.g. "Patient"). + :vartype type: str + :ivar identifier: Logical reference, when literal reference is not known. + :vartype identifier: ~azure.healthinsights.clinicalmatching.models.Identifier + :ivar display: Text alternative for the resource. + :vartype display: str + """ - All required parameters must be populated in order to send to Azure. + reference: Optional[str] = rest_field() + """Literal reference, Relative, internal or absolute URL.""" + type: Optional[str] = rest_field() + """Type the reference refers to (e.g. \"Patient\").""" + identifier: Optional["_models.Identifier"] = rest_field() + """Logical reference, when literal reference is not known.""" + display: Optional[str] = rest_field() + """Text alternative for the resource.""" - :ivar id: A given identifier for the patient. Has to be unique across all patients in a single - request. Required. + @overload + def __init__( + self, + *, + reference: Optional[str] = None, + type: Optional[str] = None, + identifier: Optional["_models.Identifier"] = None, + display: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResearchStudy(DomainResource): # pylint: disable=too-many-instance-attributes + """Detailed information about Research Study + Based on `FHIR ResearchStudy `_. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. :vartype id: str - :ivar info: Patient structured information, including demographics and known structured - clinical information. - :vartype info: ~azure.healthinsights.clinicalmatching.models.PatientInfo - :ivar data: Patient unstructured clinical data, given as documents. - :vartype data: list[~azure.healthinsights.clinicalmatching.models.PatientDocument] + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.clinicalmatching.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.clinicalmatching.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.clinicalmatching.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "ResearchStudy". + :vartype resource_type: str + :ivar identifier: Business Identifier for study. + :vartype identifier: list[~azure.healthinsights.clinicalmatching.models.Identifier] + :ivar title: Name for this study. + :vartype title: str + :ivar protocol: Steps followed in executing study. + :vartype protocol: list[~azure.healthinsights.clinicalmatching.models.Reference] + :ivar part_of: Part of larger study. + :vartype part_of: list[~azure.healthinsights.clinicalmatching.models.Reference] + :ivar status: active | administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | in-review | + temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", "administratively-completed", "approved", + "closed-to-accrual", "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", "temporarily-closed-to-accrual-and-intervention", + and "withdrawn". + :vartype status: str or + ~azure.healthinsights.clinicalmatching.models.ResearchStudyStatusCodeType + :ivar primary_purpose_type: treatment | prevention | diagnostic | supportive-care | screening | + health-services-research | basic-science | device-feasibility. + :vartype primary_purpose_type: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar phase: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | + phase-3 | phase-4. + :vartype phase: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar category: Classifications for the study. + :vartype category: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar focus: Drugs, devices, etc. under study. + :vartype focus: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar condition: Condition being studied. + :vartype condition: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar contact: Contact details for the study. + :vartype contact: list[~azure.healthinsights.clinicalmatching.models.ContactDetail] + :ivar keyword: Used to search for the study. + :vartype keyword: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar location: Geographic region(s) for study. + :vartype location: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar description: What this is study doing. + :vartype description: str + :ivar enrollment: Inclusion & exclusion criteria. + :vartype enrollment: list[~azure.healthinsights.clinicalmatching.models.Reference] + :ivar period: When the study began and ended. + :vartype period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar sponsor: Organization that initiates and is legally responsible for the study. + :vartype sponsor: ~azure.healthinsights.clinicalmatching.models.Reference + :ivar principal_investigator: Researcher who oversees multiple aspects of the study. + :vartype principal_investigator: ~azure.healthinsights.clinicalmatching.models.Reference + :ivar site: Facility where study activities are conducted. + :vartype site: list[~azure.healthinsights.clinicalmatching.models.Reference] + :ivar reason_stopped: accrual-goal-met | closed-due-to-toxicity | + closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design. + :vartype reason_stopped: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar note: Comments made about the study. + :vartype note: list[~azure.healthinsights.clinicalmatching.models.Annotation] + :ivar arm: Defined path through the study for a subject. + :vartype arm: list[~azure.healthinsights.clinicalmatching.models.ResearchStudyArm] + :ivar objective: A goal for the study. + :vartype objective: list[~azure.healthinsights.clinicalmatching.models.ResearchStudyObjective] """ - id: str = rest_field() - """A given identifier for the patient. Has to be unique across all patients in a single request. Required. """ - info: Optional["_models.PatientInfo"] = rest_field() - """Patient structured information, including demographics and known structured clinical information. """ - data: Optional[List["_models.PatientDocument"]] = rest_field() - """Patient unstructured clinical data, given as documents. """ + resource_type: Literal["ResearchStudy"] = rest_field(name="resourceType") + """resourceType. Required. Default value is \"ResearchStudy\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """Business Identifier for study.""" + title: Optional[str] = rest_field() + """Name for this study.""" + protocol: Optional[List["_models.Reference"]] = rest_field() + """Steps followed in executing study.""" + part_of: Optional[List["_models.Reference"]] = rest_field(name="partOf") + """Part of larger study.""" + status: Union[str, "_models.ResearchStudyStatusCodeType"] = rest_field() + """active | administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | in-review | + temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: \"active\", \"administratively-completed\", \"approved\", + \"closed-to-accrual\", \"closed-to-accrual-and-intervention\", \"completed\", \"disapproved\", + \"in-review\", \"temporarily-closed-to-accrual\", + \"temporarily-closed-to-accrual-and-intervention\", and \"withdrawn\".""" + primary_purpose_type: Optional["_models.CodeableConcept"] = rest_field(name="primaryPurposeType") + """treatment | prevention | diagnostic | supportive-care | screening | health-services-research | + basic-science | device-feasibility.""" + phase: Optional["_models.CodeableConcept"] = rest_field() + """n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | + phase-4.""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """Classifications for the study.""" + focus: Optional[List["_models.CodeableConcept"]] = rest_field() + """Drugs, devices, etc. under study.""" + condition: Optional[List["_models.CodeableConcept"]] = rest_field() + """Condition being studied.""" + contact: Optional[List["_models.ContactDetail"]] = rest_field() + """Contact details for the study.""" + keyword: Optional[List["_models.CodeableConcept"]] = rest_field() + """Used to search for the study.""" + location: Optional[List["_models.CodeableConcept"]] = rest_field() + """Geographic region(s) for study.""" + description: Optional[str] = rest_field() + """What this is study doing.""" + enrollment: Optional[List["_models.Reference"]] = rest_field() + """Inclusion & exclusion criteria.""" + period: Optional["_models.Period"] = rest_field() + """When the study began and ended.""" + sponsor: Optional["_models.Reference"] = rest_field() + """Organization that initiates and is legally responsible for the study.""" + principal_investigator: Optional["_models.Reference"] = rest_field(name="principalInvestigator") + """Researcher who oversees multiple aspects of the study.""" + site: Optional[List["_models.Reference"]] = rest_field() + """Facility where study activities are conducted.""" + reason_stopped: Optional["_models.CodeableConcept"] = rest_field(name="reasonStopped") + """accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | + temporarily-closed-per-study-design.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Comments made about the study.""" + arm: Optional[List["_models.ResearchStudyArm"]] = rest_field() + """Defined path through the study for a subject.""" + objective: Optional[List["_models.ResearchStudyObjective"]] = rest_field() + """A goal for the study.""" @overload def __init__( self, *, - id: str, # pylint: disable=redefined-builtin - info: Optional["_models.PatientInfo"] = None, - data: Optional[List["_models.PatientDocument"]] = None, + status: Union[str, "_models.ResearchStudyStatusCodeType"], + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + title: Optional[str] = None, + protocol: Optional[List["_models.Reference"]] = None, + part_of: Optional[List["_models.Reference"]] = None, + primary_purpose_type: Optional["_models.CodeableConcept"] = None, + phase: Optional["_models.CodeableConcept"] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + focus: Optional[List["_models.CodeableConcept"]] = None, + condition: Optional[List["_models.CodeableConcept"]] = None, + contact: Optional[List["_models.ContactDetail"]] = None, + keyword: Optional[List["_models.CodeableConcept"]] = None, + location: Optional[List["_models.CodeableConcept"]] = None, + description: Optional[str] = None, + enrollment: Optional[List["_models.Reference"]] = None, + period: Optional["_models.Period"] = None, + sponsor: Optional["_models.Reference"] = None, + principal_investigator: Optional["_models.Reference"] = None, + site: Optional[List["_models.Reference"]] = None, + reason_stopped: Optional["_models.CodeableConcept"] = None, + note: Optional[List["_models.Annotation"]] = None, + arm: Optional[List["_models.ResearchStudyArm"]] = None, + objective: Optional[List["_models.ResearchStudyObjective"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.resource_type: Literal["ResearchStudy"] = "ResearchStudy" + + +class ResearchStudyArm(_model_base.Model): + """ResearchStudyArm. + + All required parameters must be populated in order to send to server. + + :ivar name: Label for study arm. Required. + :vartype name: str + :ivar type: Categorization of study arm. + :vartype type: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar description: Short explanation of study path. + :vartype description: str + """ + + name: str = rest_field() + """Label for study arm. Required.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Categorization of study arm.""" + description: Optional[str] = rest_field() + """Short explanation of study path.""" + + @overload + def __init__( + self, + *, + name: str, + type: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResearchStudyObjective(_model_base.Model): + """ResearchStudyObjective. + + All required parameters must be populated in order to send to server. + + :ivar name: Label for the objective. Required. + :vartype name: str + :ivar type: primary | secondary | exploratory. + :vartype type: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + """ + + name: str = rest_field() + """Label for the objective. Required.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """primary | secondary | exploratory.""" + + @overload + def __init__( + self, + *, + name: str, + type: Optional["_models.CodeableConcept"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SampledData(Element): + """A series of measurements taken by a device + Based on `FHIR SampledData `_. + + All required parameters must be populated in order to send to server. + + :ivar origin: Zero value and units. Required. + :vartype origin: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar period: Number of milliseconds between samples. Required. + :vartype period: float + :ivar factor: Multiply data by this before adding to origin. + :vartype factor: float + :ivar lower_limit: Lower limit of detection. + :vartype lower_limit: float + :ivar upper_limit: Upper limit of detection. + :vartype upper_limit: float + :ivar dimensions: Number of sample points at each time point. Required. + :vartype dimensions: int + :ivar data: Decimal values with spaces, or "E" | "U" | "L". + :vartype data: str + """ + + origin: "_models.Quantity" = rest_field() + """Zero value and units. Required.""" + period: float = rest_field() + """Number of milliseconds between samples. Required.""" + factor: Optional[float] = rest_field() + """Multiply data by this before adding to origin.""" + lower_limit: Optional[float] = rest_field(name="lowerLimit") + """Lower limit of detection.""" + upper_limit: Optional[float] = rest_field(name="upperLimit") + """Upper limit of detection.""" + dimensions: int = rest_field() + """Number of sample points at each time point. Required.""" + data: Optional[str] = rest_field() + """Decimal values with spaces, or \"E\" | \"U\" | \"L\".""" + + @overload + def __init__( + self, + *, + origin: "_models.Quantity", + period: float, + dimensions: int, + factor: Optional[float] = None, + lower_limit: Optional[float] = None, + upper_limit: Optional[float] = None, + data: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TimePeriod(_model_base.Model): + """A duration of time during which an event is happening. + + :ivar start: Starting time with inclusive boundary. + :vartype start: ~datetime.datetime + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: ~datetime.datetime + """ + + start: Optional[datetime.datetime] = rest_field(format="rfc3339") + """Starting time with inclusive boundary.""" + end: Optional[datetime.datetime] = rest_field(format="rfc3339") + """End time with inclusive boundary, if not ongoing.""" + + @overload + def __init__( + self, + *, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, ): ... @@ -1097,9 +2995,9 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class TrialMatcherData(_model_base.Model): - """TrialMatcherData. + """The body of the Trial Matcher request. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar patients: The list of patients, including their clinical information and data. Required. :vartype patients: list[~azure.healthinsights.clinicalmatching.models.PatientRecord] @@ -1109,9 +3007,9 @@ class TrialMatcherData(_model_base.Model): """ patients: List["_models.PatientRecord"] = rest_field() - """The list of patients, including their clinical information and data. Required. """ + """The list of patients, including their clinical information and data. Required.""" configuration: Optional["_models.TrialMatcherModelConfiguration"] = rest_field() - """Configuration affecting the Trial Matcher model's inference. """ + """Configuration affecting the Trial Matcher model's inference.""" @overload def __init__( @@ -1136,7 +3034,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class TrialMatcherInference(_model_base.Model): """An inference made by the Trial Matcher model regarding a patient. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar type: The type of the Trial Matcher inference. Required. "trialEligibility" :vartype type: str or ~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceType @@ -1149,8 +3047,8 @@ class TrialMatcherInference(_model_base.Model): :ivar evidence: The evidence corresponding to the inference value. :vartype evidence: list[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceEvidence] - :ivar id: The identifier of the clinical trial. - :vartype id: str + :ivar clinical_trial_id: The identifier of the clinical trial. + :vartype clinical_trial_id: str :ivar source: Possible sources of a clinical trial. Known values are: "custom" and "clinicaltrials.gov". :vartype source: str or ~azure.healthinsights.clinicalmatching.models.ClinicalTrialSource @@ -1158,33 +3056,33 @@ class TrialMatcherInference(_model_base.Model): :vartype metadata: ~azure.healthinsights.clinicalmatching.models.ClinicalTrialMetadata """ - type: Union[str, "_models.TrialMatcherInferenceType"] = rest_field() # pylint: disable=redefined-builtin + type: Union[str, "_models.TrialMatcherInferenceType"] = rest_field() """The type of the Trial Matcher inference. Required. \"trialEligibility\"""" value: str = rest_field() - """The value of the inference, as relevant for the given inference type. Required. """ + """The value of the inference, as relevant for the given inference type. Required.""" description: Optional[str] = rest_field() - """The description corresponding to the inference value. """ + """The description corresponding to the inference value.""" confidence_score: Optional[float] = rest_field(name="confidenceScore") - """Confidence score for this inference. """ + """Confidence score for this inference.""" evidence: Optional[List["_models.TrialMatcherInferenceEvidence"]] = rest_field() - """The evidence corresponding to the inference value. """ - id: Optional[str] = rest_field() - """The identifier of the clinical trial. """ + """The evidence corresponding to the inference value.""" + clinical_trial_id: Optional[str] = rest_field(name="clinicalTrialId") + """The identifier of the clinical trial.""" source: Optional[Union[str, "_models.ClinicalTrialSource"]] = rest_field() """Possible sources of a clinical trial. Known values are: \"custom\" and \"clinicaltrials.gov\".""" metadata: Optional["_models.ClinicalTrialMetadata"] = rest_field() - """Trial data which is of interest to the potential participant. """ + """Trial data which is of interest to the potential participant.""" @overload def __init__( self, *, - type: Union[str, "_models.TrialMatcherInferenceType"], # pylint: disable=redefined-builtin + type: Union[str, "_models.TrialMatcherInferenceType"], value: str, description: Optional[str] = None, confidence_score: Optional[float] = None, evidence: Optional[List["_models.TrialMatcherInferenceEvidence"]] = None, - id: Optional[str] = None, # pylint: disable=redefined-builtin + clinical_trial_id: Optional[str] = None, source: Optional[Union[str, "_models.ClinicalTrialSource"]] = None, metadata: Optional["_models.ClinicalTrialMetadata"] = None, ): @@ -1220,14 +3118,14 @@ class TrialMatcherInferenceEvidence(_model_base.Model): """ eligibility_criteria_evidence: Optional[str] = rest_field(name="eligibilityCriteriaEvidence") - """A piece of evidence from the eligibility criteria text of a clinical trial. """ + """A piece of evidence from the eligibility criteria text of a clinical trial.""" patient_data_evidence: Optional["_models.ClinicalNoteEvidence"] = rest_field(name="patientDataEvidence") - """A piece of evidence from a clinical note (text document). """ + """A piece of evidence from a clinical note (text document).""" patient_info_evidence: Optional["_models.ClinicalCodedElement"] = rest_field(name="patientInfoEvidence") """A piece of clinical information, expressed as a code in a clinical coding -system. """ + system.""" importance: Optional[float] = rest_field() - """A value indicating how important this piece of evidence is for the inference. """ + """A value indicating how important this piece of evidence is for the inference.""" @overload def __init__( @@ -1251,10 +3149,54 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) +class TrialMatcherInferenceResult(_model_base.Model): + """The inference results for the Trial Matcher request. + + All required parameters must be populated in order to send to server. + + :ivar patient_results: Results for the patients given in the request. Required. + :vartype patient_results: + list[~azure.healthinsights.clinicalmatching.models.TrialMatcherPatientResult] + :ivar model_version: The version of the model used for inference, expressed as the model date. + Required. + :vartype model_version: str + :ivar knowledge_graph_last_update_date: The date when the clinical trials knowledge graph was + last updated. + :vartype knowledge_graph_last_update_date: ~datetime.date + """ + + patient_results: List["_models.TrialMatcherPatientResult"] = rest_field(name="patientResults") + """Results for the patients given in the request. Required.""" + model_version: str = rest_field(name="modelVersion") + """The version of the model used for inference, expressed as the model date. Required.""" + knowledge_graph_last_update_date: Optional[datetime.date] = rest_field(name="knowledgeGraphLastUpdateDate") + """The date when the clinical trials knowledge graph was last updated.""" + + @overload + def __init__( + self, + *, + patient_results: List["_models.TrialMatcherPatientResult"], + model_version: str, + knowledge_graph_last_update_date: Optional[datetime.date] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + class TrialMatcherModelConfiguration(_model_base.Model): """Configuration affecting the Trial Matcher model's inference. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar verbose: An indication whether the model should produce verbose output. :vartype verbose: bool @@ -1269,23 +3211,23 @@ class TrialMatcherModelConfiguration(_model_base.Model): :vartype clinical_trials: ~azure.healthinsights.clinicalmatching.models.ClinicalTrials """ - verbose: bool = rest_field(default=False) - """An indication whether the model should produce verbose output. """ - include_evidence: bool = rest_field(name="includeEvidence", default=True) - """An indication whether the model's output should include evidence for the inferences. """ + verbose: Optional[bool] = rest_field() + """An indication whether the model should produce verbose output.""" + include_evidence: Optional[bool] = rest_field(name="includeEvidence") + """An indication whether the model's output should include evidence for the inferences.""" clinical_trials: "_models.ClinicalTrials" = rest_field(name="clinicalTrials") """The clinical trials that the patient(s) should be matched to. :code:`
`The trial -selection can be given as a list of custom clinical trials and/or a list of -filters to known clinical trial registries. In case both are given, the -resulting trial set is a union of the two sets. Required. """ + selection can be given as a list of custom clinical trials and/or a list of + filters to known clinical trial registries. In case both are given, the + resulting trial set is a union of the two sets. Required.""" @overload def __init__( self, *, clinical_trials: "_models.ClinicalTrials", - verbose: bool = False, - include_evidence: bool = True, + verbose: Optional[bool] = None, + include_evidence: Optional[bool] = None, ): ... @@ -1303,32 +3245,30 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class TrialMatcherPatientResult(_model_base.Model): """The results of the model's work for a single patient. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. - :ivar id: The identifier given for the patient in the request. Required. - :vartype id: str - :ivar inferences: The model's inferences for the given patient. Required. + :ivar patient_id: The identifier given for the patient in the request. Required. + :vartype patient_id: str + :ivar inferences: The inference results for the patient. Required. :vartype inferences: list[~azure.healthinsights.clinicalmatching.models.TrialMatcherInference] :ivar needed_clinical_info: Clinical information which is needed to provide better trial - matching results for the patient. Clinical information which is needed to provide better trial matching results for the patient. :vartype needed_clinical_info: list[~azure.healthinsights.clinicalmatching.models.ExtendedClinicalCodedElement] """ - id: str = rest_field() - """The identifier given for the patient in the request. Required. """ + patient_id: str = rest_field(name="patientId") + """The identifier given for the patient in the request. Required.""" inferences: List["_models.TrialMatcherInference"] = rest_field() - """The model's inferences for the given patient. Required. """ + """The inference results for the patient. Required.""" needed_clinical_info: Optional[List["_models.ExtendedClinicalCodedElement"]] = rest_field(name="neededClinicalInfo") - """Clinical information which is needed to provide better trial matching results for the patient. Clinical - information which is needed to provide better trial matching results for the patient. """ + """Clinical information which is needed to provide better trial matching results for the patient.""" @overload def __init__( self, *, - id: str, # pylint: disable=redefined-builtin + patient_id: str, inferences: List["_models.TrialMatcherInference"], needed_clinical_info: Optional[List["_models.ExtendedClinicalCodedElement"]] = None, ): @@ -1343,90 +3283,3 @@ def __init__(self, mapping: Mapping[str, Any]): def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) - - -class TrialMatcherResult(_model_base.Model): - """The response for the Trial Matcher request. - - Readonly variables are only populated by the server, and will be ignored when sending a request. - - All required parameters must be populated in order to send to Azure. - - :ivar job_id: A processing job identifier. Required. - :vartype job_id: str - :ivar created_date_time: The date and time when the processing job was created. Required. - :vartype created_date_time: ~datetime.datetime - :ivar expiration_date_time: The date and time when the processing job is set to expire. - Required. - :vartype expiration_date_time: ~datetime.datetime - :ivar last_update_date_time: The date and time when the processing job was last updated. - Required. - :vartype last_update_date_time: ~datetime.datetime - :ivar status: The status of the processing job. Required. Known values are: "notStarted", - "running", "succeeded", "failed", and "partiallyCompleted". - :vartype status: str or ~azure.healthinsights.clinicalmatching.models.JobStatus - :ivar errors: An array of errors, if any errors occurred during the processing job. - :vartype errors: list[~azure.healthinsights.clinicalmatching.models.Error] - :ivar results: The inference results for the Trial Matcher request. - :vartype results: ~azure.healthinsights.clinicalmatching.models.TrialMatcherResults - """ - - job_id: str = rest_field(name="jobId", readonly=True) - """A processing job identifier. Required. """ - created_date_time: datetime.datetime = rest_field(name="createdDateTime", readonly=True) - """The date and time when the processing job was created. Required. """ - expiration_date_time: datetime.datetime = rest_field(name="expirationDateTime", readonly=True) - """The date and time when the processing job is set to expire. Required. """ - last_update_date_time: datetime.datetime = rest_field(name="lastUpdateDateTime", readonly=True) - """The date and time when the processing job was last updated. Required. """ - status: Union[str, "_models.JobStatus"] = rest_field(readonly=True) - """The status of the processing job. Required. Known values are: \"notStarted\", \"running\", \"succeeded\", - \"failed\", and \"partiallyCompleted\". """ - errors: Optional[List["_models.Error"]] = rest_field(readonly=True) - """An array of errors, if any errors occurred during the processing job. """ - results: Optional["_models.TrialMatcherResults"] = rest_field(readonly=True) - """The inference results for the Trial Matcher request. """ - - -class TrialMatcherResults(_model_base.Model): - """The inference results for the Trial Matcher request. - - All required parameters must be populated in order to send to Azure. - - :ivar patients: Results for the patients given in the request. Required. - :vartype patients: - list[~azure.healthinsights.clinicalmatching.models.TrialMatcherPatientResult] - :ivar model_version: The version of the model used for inference, expressed as the model date. - Required. - :vartype model_version: str - :ivar knowledge_graph_last_update_date: The date when the clinical trials knowledge graph was - last updated. - :vartype knowledge_graph_last_update_date: ~datetime.date - """ - - patients: List["_models.TrialMatcherPatientResult"] = rest_field() - """Results for the patients given in the request. Required. """ - model_version: str = rest_field(name="modelVersion") - """The version of the model used for inference, expressed as the model date. Required. """ - knowledge_graph_last_update_date: Optional[datetime.date] = rest_field(name="knowledgeGraphLastUpdateDate") - """The date when the clinical trials knowledge graph was last updated. """ - - @overload - def __init__( - self, - *, - patients: List["_models.TrialMatcherPatientResult"], - model_version: str, - knowledge_graph_last_update_date: Optional[datetime.date] = None, - ): - ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_fhir_async.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_fhir_async.py index b58c06ef57291..29b1925c14c65 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_fhir_async.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_fhir_async.py @@ -41,8 +41,7 @@ async def match_trials_async(self) -> None: # Create aTrial Matcher client # - trial_matcher_client = ClinicalMatchingClient(endpoint=ENDPOINT, - credential=AzureKeyCredential(KEY)) + trial_matcher_client = ClinicalMatchingClient(endpoint=ENDPOINT, credential=AzureKeyCredential(KEY)) # # Construct Patient @@ -59,9 +58,9 @@ async def match_trials_async(self) -> None: # Specify the clinical trial registry source as ClinicalTrials.Gov registry_filters.sources = [models.ClinicalTrialSource.CLINICALTRIALS_GOV] # Limit the clinical trial to a certain location, in this case California, USA - registry_filters.facility_locations = [models.GeographicLocation(country_or_region="United States", - city="Gilbert", - state="Arizona")] + registry_filters.facility_locations = [ + models.GeographicLocation(country_or_region="United States", city="Gilbert", state="Arizona") + ] # Limit the trial to a specific study type, interventional registry_filters.study_types = [models.ClinicalTrialStudyType.INTERVENTIONAL] @@ -100,19 +99,21 @@ def print_results(trial_matcher_result): def get_patient_from_fhir_patient(self) -> models.PatientRecord: patient_info = models.PatientInfo(sex=models.PatientInfoSex.MALE, birth_date=datetime.date(1965, 12, 26)) - patient_data = models.PatientDocument(type=models.DocumentType.FHIR_BUNDLE, - id="Consultation-14-Demo", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=self.get_patient_doc_content()), - clinical_type=models.ClinicalDocumentType.CONSULTATION) + patient_data = models.PatientDocument( + type=models.DocumentType.FHIR_BUNDLE, + id="Consultation-14-Demo", + content=models.DocumentContent( + source_type=models.DocumentContentSourceType.INLINE, value=self.get_patient_doc_content() + ), + clinical_type=models.ClinicalDocumentType.CONSULTATION, + ) return models.PatientRecord(id="patient_id", info=patient_info, data=[patient_data]) @staticmethod def get_patient_doc_content() -> str: samples_dir = os.path.dirname(os.path.realpath(__file__)) data_location = os.path.join(samples_dir, "../sample_data/match_trial_fhir_data.json") - with open(data_location, 'r', encoding='utf-8-sig') as f: + with open(data_location, "r", encoding="utf-8-sig") as f: content = f.read() return content diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_structured_coded_elements_async.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_structured_coded_elements_async.py index 5347b105c4cc1..836e4df9fc32a 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_structured_coded_elements_async.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_structured_coded_elements_async.py @@ -38,59 +38,63 @@ async def match_trials_async(self) -> None: # Create a Trial Matcher client # - trial_matcher_client = ClinicalMatchingClient(endpoint=ENDPOINT, - credential=AzureKeyCredential(KEY)) + trial_matcher_client = ClinicalMatchingClient(endpoint=ENDPOINT, credential=AzureKeyCredential(KEY)) # # Create clinical info list # - clinical_info_list = [models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0006826", - name="Malignant Neoplasms", - value="true"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C1522449", - name="Therapeutic radiology procedure", - value="true"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="METASTATIC", - name="metastatic", - value="true"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C1512162", - name="Eastern Cooperative Oncology Group", - value="1"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0019693", - name="HIV Infections", - value="false"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C1300072", - name="Tumor stage", - value="2"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0019163", - name="Hepatitis B", - value="false"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0018802", - name="Congestive heart failure", - value="true"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0019196", - name="Hepatitis C", - value="false"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0220650", - name="Metastatic malignant neoplasm to brain", - value="true")] + clinical_info_list = [ + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C0006826", name="Malignant Neoplasms", value="true" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", + code="C1522449", + name="Therapeutic radiology procedure", + value="true", + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="METASTATIC", name="metastatic", value="true" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", + code="C1512162", + name="Eastern Cooperative Oncology Group", + value="1", + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C0019693", name="HIV Infections", value="false" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C1300072", name="Tumor stage", value="2" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C0019163", name="Hepatitis B", value="false" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", + code="C0018802", + name="Congestive heart failure", + value="true", + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C0019196", name="Hepatitis C", value="false" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", + code="C0220650", + name="Metastatic malignant neoplasm to brain", + value="true", + ), + ] # # Construct Patient # - patient_info = models.PatientInfo(sex=models.PatientInfoSex.MALE, birth_date=datetime.date(1965, 12, 26), - clinical_info=clinical_info_list) + patient_info = models.PatientInfo( + sex=models.PatientInfoSex.MALE, birth_date=datetime.date(1965, 12, 26), clinical_info=clinical_info_list + ) patient1 = models.PatientRecord(id="patient_id", info=patient_info) # @@ -103,9 +107,9 @@ async def match_trials_async(self) -> None: # Specify the clinical trial registry source as ClinicalTrials.Gov registry_filters.sources = [models.ClinicalTrialSource.CLINICALTRIALS_GOV] # Limit the clinical trial to a certain location, in this case California, USA - registry_filters.facility_locations = [models.GeographicLocation(country_or_region="United States", - city="Gilbert", - state="Arizona")] + registry_filters.facility_locations = [ + models.GeographicLocation(country_or_region="United States", city="Gilbert", state="Arizona") + ] # Limit the trial to a specific study type, interventional registry_filters.study_types = [models.ClinicalTrialStudyType.INTERVENTIONAL] diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_fhir.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_fhir.py index 7cf643015e187..af14ec3fc323f 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_fhir.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_fhir.py @@ -57,7 +57,8 @@ def match_trials(self) -> None: registry_filters.sources = [models.ClinicalTrialSource.CLINICALTRIALS_GOV] # Limit the clinical trial to a certain location, in this case California, USA registry_filters.facility_locations = [ - models.GeographicLocation(country_or_region="United States", city="Gilbert", state="Arizona")] + models.GeographicLocation(country_or_region="United States", city="Gilbert", state="Arizona") + ] # Limit the trial to a specific study type, interventional registry_filters.study_types = [models.ClinicalTrialStudyType.INTERVENTIONAL] @@ -96,19 +97,21 @@ def print_results(trial_matcher_result): def get_patient_from_fhir_patient(self) -> models.PatientRecord: patient_info = models.PatientInfo(sex=models.PatientInfoSex.MALE, birth_date=datetime.date(1965, 12, 26)) - patient_data = models.PatientDocument(type=models.DocumentType.FHIR_BUNDLE, - id="Consultation-14-Demo", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=self.get_patient_doc_content()), - clinical_type=models.ClinicalDocumentType.CONSULTATION) + patient_data = models.PatientDocument( + type=models.DocumentType.FHIR_BUNDLE, + id="Consultation-14-Demo", + content=models.DocumentContent( + source_type=models.DocumentContentSourceType.INLINE, value=self.get_patient_doc_content() + ), + clinical_type=models.ClinicalDocumentType.CONSULTATION, + ) return models.PatientRecord(id="patient_id", info=patient_info, data=[patient_data]) @staticmethod def get_patient_doc_content() -> str: samples_dir = os.path.dirname(os.path.realpath(__file__)) data_location = os.path.join(samples_dir, "sample_data/match_trial_fhir_data.json") - with open(data_location, 'r', encoding='utf-8-sig') as f: + with open(data_location, "r", encoding="utf-8-sig") as f: content = f.read() return content diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_structured_coded_elements.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_structured_coded_elements.py index 7f7310135d912..ba39ee2b8fc6d 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_structured_coded_elements.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_structured_coded_elements.py @@ -38,39 +38,39 @@ def match_trials(self): # Create a Trial Matcher client # - trial_matcher_client = ClinicalMatchingClient(endpoint=ENDPOINT, - credential=AzureKeyCredential(KEY)) + trial_matcher_client = ClinicalMatchingClient(endpoint=ENDPOINT, credential=AzureKeyCredential(KEY)) # # Create clinical info list # - clinical_info_list = [models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0032181", - name="Platelet count", - value="250000"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0002965", - name="Unstable Angina", - value="true"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C1522449", - name="Radiotherapy", - value="false"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0242957", - name="GeneOrProtein-Expression", - value="Negative;EntityType:GENEORPROTEIN-EXPRESSION"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C1300072", - name="cancer stage", - value="2")] + clinical_info_list = [ + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C0032181", name="Platelet count", value="250000" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C0002965", name="Unstable Angina", value="true" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C1522449", name="Radiotherapy", value="false" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", + code="C0242957", + name="GeneOrProtein-Expression", + value="Negative;EntityType:GENEORPROTEIN-EXPRESSION", + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C1300072", name="cancer stage", value="2" + ), + ] # # Construct Patient # - patient_info = models.PatientInfo(sex=models.PatientInfoSex.MALE, birth_date=datetime.date(1965, 12, 26), - clinical_info=clinical_info_list) + patient_info = models.PatientInfo( + sex=models.PatientInfoSex.MALE, birth_date=datetime.date(1965, 12, 26), clinical_info=clinical_info_list + ) patient1 = models.PatientRecord(id="patient_id", info=patient_info) # @@ -82,7 +82,8 @@ def match_trials(self): registry_filters.sources = [models.ClinicalTrialSource.CLINICALTRIALS_GOV] # Limit the clinical trial to a certain location, in this case California, USA registry_filters.facility_locations = [ - models.GeographicLocation(country_or_region="United States", city="Gilbert", state="Arizona")] + models.GeographicLocation(country_or_region="United States", city="Gilbert", state="Arizona") + ] # Limit the trial to a specific recruitment status registry_filters.recruitment_statuses = [models.ClinicalTrialRecruitmentStatus.RECRUITING] diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/setup.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/setup.py index dcd818c0a9787..8809802997fcd 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/setup.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/setup.py @@ -13,7 +13,7 @@ PACKAGE_NAME = "azure-healthinsights-clinicalmatching" -PACKAGE_PPRINT_NAME = "Cognitive Services Health Insights Clinical Matching" +PACKAGE_PPRINT_NAME = "Azure Health Insights - Clinical Matching" # a-b-c => a/b/c package_folder_path = PACKAGE_NAME.replace("-", "/") @@ -29,7 +29,7 @@ setup( name=PACKAGE_NAME, version=version, - description='Microsoft {} Client Library for Python'.format(PACKAGE_PPRINT_NAME), + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), long_description=open("README.md", "r").read(), long_description_content_type="text/markdown", license="MIT License", @@ -42,11 +42,11 @@ "Programming Language :: Python", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "License :: OSI Approved :: MIT License", ], zip_safe=False, @@ -60,12 +60,11 @@ ), include_package_data=True, package_data={ - "pytyped": ["py.typed"], + "azure.healthinsights.clinicalmatching": ["py.typed"], }, install_requires=[ "isodate<1.0.0,>=0.6.1", - "azure-core<2.0.0,>=1.24.0", - "typing-extensions>=4.3.0; python_version<'3.8.0'", + "azure-core<2.0.0,>=1.29.5", ], - python_requires=">=3.7", + python_requires=">=3.8", ) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/conftest.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/conftest.py index ce09206dd2994..1c59fd964e908 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/conftest.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/conftest.py @@ -47,6 +47,4 @@ def add_sanitizers(test_proxy): add_general_regex_sanitizer( regex=healthinsights_endpoint, value="https://fake_ad_resource.cognitiveservices.azure.com/" ) - add_general_regex_sanitizer( - regex=healthinsights_key, value="00000000000000000000000000000000" - ) + add_general_regex_sanitizer(regex=healthinsights_key, value="00000000000000000000000000000000") diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/test_match_trials.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/test_match_trials.py index 24da4826c1d3b..df03caea92a28 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/test_match_trials.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/test_match_trials.py @@ -19,12 +19,12 @@ class TestMatchTrials(AzureRecordedTestCase): - @HealthInsightsEnvPreparer() @recorded_by_proxy def test_match_trials(self, healthinsights_endpoint, healthinsights_key): - clinical_matching_client = ClinicalMatchingClient(healthinsights_endpoint, - AzureKeyCredential(healthinsights_key)) + clinical_matching_client = ClinicalMatchingClient( + healthinsights_endpoint, AzureKeyCredential(healthinsights_key) + ) assert clinical_matching_client is not None @@ -33,26 +33,16 @@ def test_match_trials(self, healthinsights_endpoint, healthinsights_key): "clinicalTrials": { "registryFilters": [ { - "conditions": [ - "non small cell lung cancer (nsclc)" - ], - "sources": [ - "clinicaltrials_gov" - ], - "recruitmentStatuses": [ - "recruiting" - ], + "conditions": ["non small cell lung cancer (nsclc)"], + "sources": ["clinicaltrials_gov"], + "recruitmentStatuses": ["recruiting"], "facilityLocations": [ - { - "city": "gilbert", - "state": "arizona", - "countryOrRegion": "United States" - } - ] + {"city": "gilbert", "state": "arizona", "countryOrRegion": "United States"} + ], } ] }, - "includeEvidence": True + "includeEvidence": True, }, "patients": [ { @@ -60,39 +50,41 @@ def test_match_trials(self, healthinsights_endpoint, healthinsights_key): "info": { "sex": "male", "birthDate": "1961-04-25T09:54:29.5210127+00:00", - "clinicalInfo": [{ - "system": "http://www.nlm.nih.gov/research/umls", - "code": "C0032181", - "name": "Platelet count", - "value": "250000" - }, + "clinicalInfo": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0032181", + "name": "Platelet count", + "value": "250000", + }, { "system": "http://www.nlm.nih.gov/research/umls", "code": "C0002965", "name": "Unstable Angina", - "value": "true" + "value": "true", }, { "system": "http://www.nlm.nih.gov/research/umls", "code": "C1522449", "name": "Radiotherapy", - "value": "false" + "value": "false", }, { "system": "http://www.nlm.nih.gov/research/umls", "code": "C0242957", "name": "GeneOrProtein-Expression", - "value": "Negative;EntityType:GENEORPROTEIN-EXPRESSION" + "value": "Negative;EntityType:GENEORPROTEIN-EXPRESSION", }, { "system": "http://www.nlm.nih.gov/research/umls", "code": "C1300072", "name": "cancer stage", - "value": "2" - }] - } + "value": "2", + }, + ], + }, } - ] + ], } poller = clinical_matching_client.begin_match_trials(data) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/tsp-location.yaml b/sdk/healthinsights/azure-healthinsights-clinicalmatching/tsp-location.yaml new file mode 100644 index 0000000000000..270db372939b8 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/tsp-location.yaml @@ -0,0 +1,7 @@ +repo: Azure/azure-rest-api-specs +commit: f3dcae0fb8ccf9267fa0c8eb32f52125c58cd0fd +additionalDirectories: +- specification/ai/HealthInsights/HealthInsights.Common/ +- specification/ai/HealthInsights/HealthInsights.OpenAPI/ +directory: specification/ai/HealthInsights/HealthInsights.TrialMatcher + diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/CHANGELOG.md b/sdk/healthinsights/azure-healthinsights-patienttimeline/CHANGELOG.md new file mode 100644 index 0000000000000..628743d283a92 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/CHANGELOG.md @@ -0,0 +1,5 @@ +# Release History + +## 1.0.0b1 (1970-01-01) + +- Initial version diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/LICENSE b/sdk/healthinsights/azure-healthinsights-patienttimeline/LICENSE new file mode 100644 index 0000000000000..63447fd8bbbf7 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/MANIFEST.in b/sdk/healthinsights/azure-healthinsights-patienttimeline/MANIFEST.in new file mode 100644 index 0000000000000..2b5f05d0f32a3 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/MANIFEST.in @@ -0,0 +1,7 @@ +include *.md +include LICENSE +include azure/healthinsights/patienttimeline/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py +include azure/healthinsights/__init__.py \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/README.md b/sdk/healthinsights/azure-healthinsights-patienttimeline/README.md new file mode 100644 index 0000000000000..2c24bc74d1fc4 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/README.md @@ -0,0 +1,45 @@ + + +# Azure Health Insights - Patient Timeline client library for Python + + +## Getting started + +### Installating the package + +```bash +python -m pip install azure-healthinsights-patienttimeline +``` + +#### Prequisites + +- Python 3.8 or later is required to use this package. +- You need an [Azure subscription][azure_sub] to use this package. +- An existing Azure Health Insights - Patient Timeline instance. + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, +see the Code of Conduct FAQ or contact opencode@microsoft.com with any +additional questions or comments. + + +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token +[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials +[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential +[pip]: https://pypi.org/project/pip/ +[azure_sub]: https://azure.microsoft.com/free/ + diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/_meta.json b/sdk/healthinsights/azure-healthinsights-patienttimeline/_meta.json new file mode 100644 index 0000000000000..b12e89547e6fb --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "f3dcae0fb8ccf9267fa0c8eb32f52125c58cd0fd", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/ai/HealthInsights/HealthInsights.PatientTimeline", + "@azure-tools/typespec-python": "0.18.3" +} \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/__init__.py new file mode 100644 index 0000000000000..d55ccad1f573f --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/__init__.py new file mode 100644 index 0000000000000..d55ccad1f573f --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/__init__.py new file mode 100644 index 0000000000000..61f886258bf59 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/__init__.py @@ -0,0 +1,26 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import PatientTimelineClient +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "PatientTimelineClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_client.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_client.py new file mode 100644 index 0000000000000..94be4720ff56e --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_client.py @@ -0,0 +1,98 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any + +from azure.core import PipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import PatientTimelineClientConfiguration +from ._operations import PatientTimelineClientOperationsMixin +from ._serialization import Deserializer, Serializer + + +class PatientTimelineClient(PatientTimelineClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword + """PatientTimelineClient. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + _endpoint = "{endpoint}/health-insights" + self._config = PatientTimelineClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> "PatientTimelineClient": + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_configuration.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_configuration.py new file mode 100644 index 0000000000000..b091892ebf728 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_configuration.py @@ -0,0 +1,62 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +from ._version import VERSION + + +class PatientTimelineClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for PatientTimelineClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + kwargs.setdefault("sdk_moniker", "healthinsights-patienttimeline/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AzureKeyCredentialPolicy( + self.credential, "Ocp-Apim-Subscription-Key", **kwargs + ) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_model_base.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_model_base.py new file mode 100644 index 0000000000000..585ccb0e0f90a --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_model_base.py @@ -0,0 +1,828 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except +# pyright: reportGeneralTypeIssues=false + +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import copy +import typing +import email +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] # pylint: disable=protected-access + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): # pylint: disable=unsubscriptable-object + def __init__(self, data: typing.Dict[str, typing.Any]) -> None: + self._data = copy.deepcopy(data) + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + try: + return self[key] + except KeyError: + return default + + @typing.overload # type: ignore + def pop(self, key: str) -> typing.Any: # pylint: disable=no-member + ... + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: + ... + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> typing.Tuple[str, typing.Any]: + return self._data.popitem() + + def clear(self) -> None: + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: + self._data.update(*args, **kwargs) + + @typing.overload # type: ignore + def setdefault(self, key: str) -> typing.Any: + ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: + ... + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field( + attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str +) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + return _deserialize(rf._type, value) if (rf and rf._is_model) else _serialize(value, rf._format if rf else None) + + +class Model(_MyMutableMapping): + _is_model = True + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> "Model": # pylint: disable=unused-argument + # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' + mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order + attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") # pylint: disable=no-member + for k, v in mro_class.__annotations__.items() # pylint: disable=no-member + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items()) + + return super().__new__(cls) # pylint: disable=no-value-for-parameter + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): # pylint: disable=no-member + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: + for v in cls.__dict__.values(): + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access + return v._rest_name # pylint: disable=protected-access + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): # pylint: disable=no-member + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pylint: disable=no-member + if mapped_cls == cls: + return cls(data) + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore[reportUnboundVariable] + continue + result[k] = Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return [Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v] + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation or annotation in [int, float]: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + return functools.partial(_deserialize_model, annotation) + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf + ) + + def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + except AttributeError: + pass + + if getattr(annotation, "__origin__", None) is typing.Union: + deserializers = [_get_deserialize_callable_from_annotation(arg, module, rf) for arg in annotation.__args__] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) + + try: + if annotation._name == "Dict": + value_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[1], module, rf) + + def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + obj: typing.Dict[typing.Any, typing.Any], + ): + if obj is None: + return obj + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + return functools.partial( + _deserialize_dict, + value_deserializer, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: + if len(annotation.__args__) > 1: + + def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, + ): + if obj is None: + return obj + return type(obj)( + _deserialize(deserializer, entry, module) + for entry, deserializer in zip(obj, entry_deserializers) + ) + + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) for dt in annotation.__args__ + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers) + deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) + + def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + obj, + ): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + return functools.partial(_deserialize_sequence, deserializer) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): + try: + if value is None or isinstance(value, _Null): + return None + if deserializer is None: + return value + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, +) -> typing.Any: + return _RestField(name=name, type=type, visibility=visibility, default=default, format=format) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/__init__.py new file mode 100644 index 0000000000000..c061989989731 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/__init__.py @@ -0,0 +1,19 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import PatientTimelineClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "PatientTimelineClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_operations.py new file mode 100644 index 0000000000000..b2c34fc0b4afb --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_operations.py @@ -0,0 +1,3053 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import datetime +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload +import uuid + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.polling import LROPoller, NoPolling, PollingMethod +from azure.core.polling.base_polling import LROBasePolling +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._model_base import SdkJSONEncoder, _deserialize +from .._serialization import Serializer +from .._vendor import PatientTimelineClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_patient_timeline_infer_patient_timeline_request( # pylint: disable=name-too-long + **kwargs: Any, +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/patient-timeline/jobs" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if "Repeatability-Request-ID" not in _headers: + _headers["Repeatability-Request-ID"] = str(uuid.uuid4()) + if "Repeatability-First-Sent" not in _headers: + _headers["Repeatability-First-Sent"] = _SERIALIZER.serialize_data( + datetime.datetime.now(datetime.timezone.utc), "rfc-1123" + ) + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +class PatientTimelineClientOperationsMixin(PatientTimelineClientMixinABC): + def _infer_patient_timeline_initial( + self, body: Union[_models.PatientTimelineData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[JSON] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_patient_timeline_infer_patient_timeline_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(JSON, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_infer_patient_timeline( + self, body: _models.PatientTimelineData, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Required. + :type body: ~azure.healthinsights.patienttimeline.models.PatientTimelineData + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + + @overload + def begin_infer_patient_timeline( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + + @overload + def begin_infer_patient_timeline( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + + @distributed_trace + def begin_infer_patient_timeline( + self, body: Union[_models.PatientTimelineData, JSON, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Is one of the following types: PatientTimelineData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.patienttimeline.models.PatientTimelineData or JSON or + IO[bytes] + :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default + value is None. + :paramtype content_type: str + :return: An instance of LROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.PatientTimelineInferenceResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._infer_patient_timeline_initial( + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response_headers = {} + response = pipeline_response.http_response + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.PatientTimelineInferenceResult, response.json().get("result")) + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + return deserialized + + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method: PollingMethod = cast( + PollingMethod, LROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs) + ) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.PatientTimelineInferenceResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.PatientTimelineInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_patch.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_patch.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_serialization.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_serialization.py new file mode 100644 index 0000000000000..baa661cb82d24 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_serialization.py @@ -0,0 +1,2005 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the ""Software""), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. +# +# -------------------------------------------------------------------------- + +# pylint: skip-file +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Dict, + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + TypeVar, + MutableMapping, + Type, + List, + Mapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +ModelType = TypeVar("ModelType", bound="Model") +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +try: + basestring # type: ignore + unicode_str = unicode # type: ignore +except NameError: + basestring = str + unicode_str = str + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + + +class UTC(datetime.tzinfo): + """Time Zone info for handling UTC""" + + def utcoffset(self, dt): + """UTF offset for UTC is 0.""" + return datetime.timedelta(0) + + def tzname(self, dt): + """Timestamp representation.""" + return "Z" + + def dst(self, dt): + """No daylight saving for UTC.""" + return datetime.timedelta(hours=1) + + +try: + from datetime import timezone as _FixedOffset # type: ignore +except ImportError: # Python 2.7 + + class _FixedOffset(datetime.tzinfo): # type: ignore + """Fixed offset in minutes east from UTC. + Copy/pasted from Python doc + :param datetime.timedelta offset: offset in timedelta format + """ + + def __init__(self, offset): + self.__offset = offset + + def utcoffset(self, dt): + return self.__offset + + def tzname(self, dt): + return str(self.__offset.total_seconds() / 3600) + + def __repr__(self): + return "".format(self.tzname(None)) + + def dst(self, dt): + return datetime.timedelta(0) + + def __getinitargs__(self): + return (self.__offset,) + + +try: + from datetime import timezone + + TZ_UTC = timezone.utc +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[Dict[str, Any]] = {} + for k in kwargs: + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node.""" + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls: Type[ModelType], + data: Any, + key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> ModelType: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result.update(objects[valuetype]._flatten_subtype(key, objects)) + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + Remove the polymorphic key from the initial data. + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + """ + return key.replace("\\.", ".") + + +class Serializer(object): + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize(self, target_obj, data_type=None, **kwargs): + """Serialize data into a string according to type. + + :param target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises: SerializationError if serialization fails. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() + try: + attributes = target_obj._attribute_map + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized.update(target_obj.additional_properties) + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = unicode_str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + else: + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises: SerializationError if serialization fails. + :raises: ValueError if data is None + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :param bool required: Whether it's essential that the data not be + empty or None + :raises: AttributeError if required data is None. + :raises: ValueError if data is None + :raises: SerializationError if serialization fails. + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + elif data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, data.__class__) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + else: + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param data: Object to be serialized. + :param str data_type: Type of object in the iterable. + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param data: Object to be serialized. + :rtype: str + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + else: + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list attr: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param bool required: Whether the objects in the iterable must + not be None or empty. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. + :rtype: list, str + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :param bool required: Whether the objects in the dictionary must + not be None or empty. + :rtype: dict + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is unicode_str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + elif obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) + + @staticmethod + def serialize_bytearray(attr, **kwargs): + """Serialize bytearray into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): + """Serialize str into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): + """Serialize Decimal object to float. + + :param attr: Object to be serialized. + :rtype: float + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): + """Serialize long (Py2) or int (Py3). + + :param attr: Object to be serialized. + :rtype: int/long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: TypeError if format invalid. + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError: + raise TypeError("RFC1123 object must be valid Datetime object.") + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: SerializationError if format invalid. + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises: SerializationError if format invalid + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError: + raise TypeError("Unix time object must be valid Datetime object.") + + +def rest_key_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(List[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key.""" + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + else: + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + else: # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer(object): + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, basestring): + return self.deserialize_data(data, response) + elif isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None: + return data + try: + attributes = response._attribute_map # type: ignore + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + else: + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + """ + if target is None: + return None, None + + if isinstance(target, basestring): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + """ + try: + return self(target_obj, data, content_type=content_type) + except: + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param raw_data: Data to be processed. + :param content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (basestring, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param response: The response model class. + :param d_attrs: The deserialized response attributes. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [k for k, v in response._validation.items() if v.get("readonly")] + const = [k for k, v in response._validation.items() if v.get("constant")] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) + + def deserialize_data(self, data, data_type): + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in ["object", "[]", r"{}"] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + else: + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :rtype: dict + :raises: TypeError if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, basestring): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + else: + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :rtype: str, int, float or bool + :raises: TypeError if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + else: + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + elif isinstance(attr, basestring): + if attr.lower() in ["true", "1"]: + return True + elif attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + else: + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :rtype: Decimal + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :rtype: long or int + :raises: ValueError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :rtype: TimeDelta + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + else: + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :rtype: Date + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :rtype: Datetime + :raises: DeserializationError if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + else: + return date_obj diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_types.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_types.py new file mode 100644 index 0000000000000..52104a479bf79 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_types.py @@ -0,0 +1,12 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Literal, Union + +RepeatabilityResult = Union[Literal["accepted"], Literal["rejected"]] diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_vendor.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_vendor.py new file mode 100644 index 0000000000000..26be159a37007 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_vendor.py @@ -0,0 +1,26 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import PatientTimelineClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import PipelineClient + + from ._serialization import Deserializer, Serializer + + +class PatientTimelineClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "PipelineClient" + _config: PatientTimelineClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_version.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_version.py new file mode 100644 index 0000000000000..be71c81bd2821 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/__init__.py new file mode 100644 index 0000000000000..95f6482fc1543 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/__init__.py @@ -0,0 +1,23 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import PatientTimelineClient + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "PatientTimelineClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_client.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_client.py new file mode 100644 index 0000000000000..ea019fd30fcd6 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_client.py @@ -0,0 +1,100 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Awaitable + +from azure.core import AsyncPipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._serialization import Deserializer, Serializer +from ._configuration import PatientTimelineClientConfiguration +from ._operations import PatientTimelineClientOperationsMixin + + +class PatientTimelineClient(PatientTimelineClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword + """PatientTimelineClient. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + _endpoint = "{endpoint}/health-insights" + self._config = PatientTimelineClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> "PatientTimelineClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_configuration.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_configuration.py new file mode 100644 index 0000000000000..1ceb33b73ff59 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_configuration.py @@ -0,0 +1,62 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +from .._version import VERSION + + +class PatientTimelineClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for PatientTimelineClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + kwargs.setdefault("sdk_moniker", "healthinsights-patienttimeline/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AzureKeyCredentialPolicy( + self.credential, "Ocp-Apim-Subscription-Key", **kwargs + ) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/__init__.py new file mode 100644 index 0000000000000..c061989989731 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/__init__.py @@ -0,0 +1,19 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import PatientTimelineClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "PatientTimelineClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_operations.py new file mode 100644 index 0000000000000..9c8969f2c87bd --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_operations.py @@ -0,0 +1,3019 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod +from azure.core.polling.async_base_polling import AsyncLROBasePolling +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models +from ..._model_base import SdkJSONEncoder, _deserialize +from ..._operations._operations import build_patient_timeline_infer_patient_timeline_request +from .._vendor import PatientTimelineClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + + +class PatientTimelineClientOperationsMixin(PatientTimelineClientMixinABC): + async def _infer_patient_timeline_initial( + self, body: Union[_models.PatientTimelineData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[JSON] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_patient_timeline_infer_patient_timeline_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(JSON, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_infer_patient_timeline( + self, body: _models.PatientTimelineData, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Required. + :type body: ~azure.healthinsights.patienttimeline.models.PatientTimelineData + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + + @overload + async def begin_infer_patient_timeline( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + + @overload + async def begin_infer_patient_timeline( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + + @distributed_trace_async + async def begin_infer_patient_timeline( + self, body: Union[_models.PatientTimelineData, JSON, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Is one of the following types: PatientTimelineData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.patienttimeline.models.PatientTimelineData or JSON or + IO[bytes] + :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default + value is None. + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.PatientTimelineInferenceResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._infer_patient_timeline_initial( + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response_headers = {} + response = pipeline_response.http_response + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.PatientTimelineInferenceResult, response.json().get("result")) + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + return deserialized + + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method: AsyncPollingMethod = cast( + AsyncPollingMethod, + AsyncLROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs), + ) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.PatientTimelineInferenceResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.PatientTimelineInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_patch.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_patch.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_vendor.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_vendor.py new file mode 100644 index 0000000000000..ee9a06dc14af2 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_vendor.py @@ -0,0 +1,26 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import PatientTimelineClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import AsyncPipelineClient + + from .._serialization import Deserializer, Serializer + + +class PatientTimelineClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "AsyncPipelineClient" + _config: PatientTimelineClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/__init__.py new file mode 100644 index 0000000000000..0a21c8eb2a17e --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/__init__.py @@ -0,0 +1,127 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._models import Annotation +from ._models import CodeableConcept +from ._models import Coding +from ._models import Condition +from ._models import ConditionStage +from ._models import ContactDetail +from ._models import ContactPoint +from ._models import DocumentAdministrativeMetadata +from ._models import DocumentAuthor +from ._models import DocumentContent +from ._models import DomainResource +from ._models import Element +from ._models import Encounter +from ._models import Error +from ._models import Extension +from ._models import HealthInsightsOperationStatus +from ._models import Identifier +from ._models import InnerError +from ._models import Meta +from ._models import Narrative +from ._models import Observation +from ._models import ObservationComponent +from ._models import ObservationReferenceRange +from ._models import OrderedProcedure +from ._models import PatientDetails +from ._models import PatientDocument +from ._models import PatientRecord +from ._models import PatientTimelineData +from ._models import PatientTimelineInference +from ._models import PatientTimelineInferenceResult +from ._models import PatientTimelineModelConfiguration +from ._models import PatientTimelinePatientResult +from ._models import Period +from ._models import Quantity +from ._models import Range +from ._models import Ratio +from ._models import Reference +from ._models import ResearchStudy +from ._models import ResearchStudyArm +from ._models import ResearchStudyObjective +from ._models import Resource +from ._models import SampledData +from ._models import TimePeriod + +from ._enums import ClinicalDocumentType +from ._enums import ContactPointSystem +from ._enums import ContactPointUse +from ._enums import DocumentContentSourceType +from ._enums import DocumentType +from ._enums import EncounterClass +from ._enums import JobStatus +from ._enums import ObservationStatusCodeType +from ._enums import PatientSex +from ._enums import PatientTimelineInferenceType +from ._enums import ResearchStudyStatusCodeType +from ._enums import SpecialtyType +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "Annotation", + "CodeableConcept", + "Coding", + "Condition", + "ConditionStage", + "ContactDetail", + "ContactPoint", + "DocumentAdministrativeMetadata", + "DocumentAuthor", + "DocumentContent", + "DomainResource", + "Element", + "Encounter", + "Error", + "Extension", + "HealthInsightsOperationStatus", + "Identifier", + "InnerError", + "Meta", + "Narrative", + "Observation", + "ObservationComponent", + "ObservationReferenceRange", + "OrderedProcedure", + "PatientDetails", + "PatientDocument", + "PatientRecord", + "PatientTimelineData", + "PatientTimelineInference", + "PatientTimelineInferenceResult", + "PatientTimelineModelConfiguration", + "PatientTimelinePatientResult", + "Period", + "Quantity", + "Range", + "Ratio", + "Reference", + "ResearchStudy", + "ResearchStudyArm", + "ResearchStudyObjective", + "Resource", + "SampledData", + "TimePeriod", + "ClinicalDocumentType", + "ContactPointSystem", + "ContactPointUse", + "DocumentContentSourceType", + "DocumentType", + "EncounterClass", + "JobStatus", + "ObservationStatusCodeType", + "PatientSex", + "PatientTimelineInferenceType", + "ResearchStudyStatusCodeType", + "SpecialtyType", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_enums.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_enums.py new file mode 100644 index 0000000000000..ff80499885319 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_enums.py @@ -0,0 +1,210 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class ClinicalDocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the clinical document.""" + + CONSULTATION = "consultation" + DISCHARGE_SUMMARY = "dischargeSummary" + HISTORY_AND_PHYSICAL = "historyAndPhysical" + RADIOLOGY_REPORT = "radiologyReport" + PROCEDURE = "procedure" + PROGRESS = "progress" + LABORATORY = "laboratory" + PATHOLOGY_REPORT = "pathologyReport" + + +class ContactPointSystem(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Contact Point System + see https://www.hl7.org/fhir/R4/valueset-contact-point-system.html. + """ + + PHONE = "phone" + """Phone""" + FAX = "fax" + """Fax""" + EMAIL = "email" + """Email""" + PAGER = "pager" + """Pager""" + URL = "url" + """Url""" + SMS = "sms" + """Sms""" + OTHER = "other" + """Other""" + + +class ContactPointUse(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Contact Point Use + See: http://hl7.org/fhir/ValueSet/contact-point-use. + """ + + HOME = "home" + """Home""" + WORK = "work" + """Work""" + TEMP = "temp" + """Temp""" + OLD = "old" + """Old""" + MOBILE = "mobile" + """Mobile""" + + +class DocumentContentSourceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. + """ + + INLINE = "inline" + """The content is given as a string (for instance, text).""" + REFERENCE = "reference" + """The content is given as a URI.""" + + +class DocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON + document). + """ + + NOTE = "note" + FHIR_BUNDLE = "fhirBundle" + DICOM = "dicom" + GENOMIC_SEQUENCING = "genomicSequencing" + + +class EncounterClass(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR + value set--http://....). + """ + + IN_PATIENT = "inpatient" + """A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned + to a location where patients generally stay at least overnight and provided with room, board, + and continuous nursing service.""" + AMBULATORY = "ambulatory" + """The term ambulatory usually implies that the patient has come to the location and is not + assigned to a bed. Sometimes referred to as an outpatient encounter.""" + OBSERVATION = "observation" + """An encounter where the patient usually will start in different encounter, such as one in the + emergency department but then transition to this type of encounter because they require a + significant period of treatment and monitoring to determine whether or not their condition + warrants an inpatient admission or discharge.""" + EMERGENCY = "emergency" + """A patient encounter that takes place at a dedicated healthcare service delivery location where + the patient receives immediate evaluation and treatment, provided until the patient can be + discharged or responsibility for the patient's care is transferred elsewhere (for example, the + patient could be admitted as an inpatient or transferred to another facility.""" + VIRTUAL = "virtual" + """A patient encounter where the patient is not physically present for the encounter, such as in a + telehealth encounter, phone call, or electronic communication.""" + HEALTH_HOME = "healthHome" + """Healthcare encounter that takes place in the residence of the patient or a designee""" + + +class JobStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The status of the processing job.""" + + NOT_STARTED = "notStarted" + RUNNING = "running" + SUCCEEDED = "succeeded" + FAILED = "failed" + CANCELED = "canceled" + + +class ObservationStatusCodeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Observation Status + Based on `FHIR ObservationStatus + `_. + """ + + REGISTERED = "registered" + """The existence of the observation is registered, but there is no result yet available.""" + PRELIMINARY = "preliminary" + """This is an initial or interim observation: data may be incomplete or unverified.""" + FINAL = "final" + """The observation is complete and verified by an authorized person.""" + AMENDED = "amended" + """Subsequent to being Final, the observation has been modified subsequent. This includes + updates/new information and corrections.""" + CORRECTED = "corrected" + """Subsequent to being Final, the observation has been modified to correct an error in the test + result.""" + CANCELLED = "cancelled" + """The observation is unavailable because the measurement was not started or not completed (also + sometimes called "aborted").""" + ENTERED_IN_ERROR = "entered-in-error" + """The observation has been withdrawn following previous final release.""" + UNKNOWN = "unknown" + """The observation status is unknown. Note that "unknown" is a value of last resort and every + attempt should be made to provide a meaningful value other than "unknown".""" + + +class PatientSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The patient's sex.""" + + FEMALE = "female" + MALE = "male" + UNSPECIFIED = "unspecified" + + +class PatientTimelineInferenceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the Patient Timeline inference.""" + + TIMELINE_EVENT = "timelineEvent" + """The inference is a timeline event.""" + SUMMARY_ITEM = "summaryItem" + """The inference is a summary item.""" + + +class ResearchStudyStatusCodeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """https://www.hl7.org/fhir/R4/codesystem-research-study-status.html.""" + + ACTIVE = "active" + """The study is open for accrual.""" + ADMINISTRATIVELY_COMPLETED = "administratively-completed" + """Study is completed prematurely and will not resume; patients are no longer examined nor + treated.""" + APPROVED = "approved" + """Protocol is approved by the review board.""" + CLOSED_TO_ACCRUAL = "closed-to-accrual" + """Study is closed for accrual; patients can be examined and treated.""" + CLOSED_TO_ACCRUAL_AND_INTERVENTION = "closed-to-accrual-and-intervention" + """The study is closed to accrual and intervention, i.e. the study is closed to enrollment, all + study subjects have completed treatment or intervention but are still being followed according + to the primary objective of the study.""" + COMPLETED = "completed" + """Study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study + subjects have completed treatment or intervention but are still being followed according to the + primary objective of the study.""" + DISAPPROVED = "disapproved" + """Protocol was disapproved by the review board.""" + IN_REVIEW = "in-review" + """Protocol is submitted to the review board for approval.""" + TEMPORARILY_CLOSED_TO_ACCRUAL = "temporarily-closed-to-accrual" + """The study is temporarily closed to accrual; a pause in accrual while study is reviewed, but is + expected to resume.""" + TEMPORARILY_CLOSED_TO_ACCRUAL_AND_INTERVENTION = "temporarily-closed-to-accrual-and-intervention" + """Study is temporarily closed for accrual; can be potentially resumed in the future""" + WITHDRAWN = "withdrawn" + """Protocol was withdrawn by the lead organization.""" + + +class SpecialtyType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the type of the Specialty.""" + + PATHOLOGY = "pathology" + """pathology""" + RADIOLOGY = "radiology" + """radiology""" diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_models.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_models.py new file mode 100644 index 0000000000000..46a76708ef55d --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_models.py @@ -0,0 +1,2541 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +import datetime +from typing import Any, Dict, List, Literal, Mapping, Optional, TYPE_CHECKING, Union, overload + +from .. import _model_base +from .._model_base import rest_discriminator, rest_field + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from .. import models as _models + + +class Element(_model_base.Model): + """The base definition for all elements contained inside a resource. + Based on `FHIR Element `_. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + """ + + id: Optional[str] = rest_field() + """Unique id for inter-element referencing.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Annotation(Element): + """A text note which also contains information about who made the statement and when + Based on `FHIR Annotation `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar author_string: Individual responsible for the annotation. + :vartype author_string: str + :ivar time: When the annotation was made. + :vartype time: str + :ivar text: The annotation - text content (as markdown). Required. + :vartype text: str + """ + + author_string: Optional[str] = rest_field(name="authorString") + """Individual responsible for the annotation.""" + time: Optional[str] = rest_field() + """When the annotation was made.""" + text: str = rest_field() + """The annotation - text content (as markdown). Required.""" + + @overload + def __init__( + self, + *, + text: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + author_string: Optional[str] = None, + time: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CodeableConcept(Element): + """Concept - reference to a terminology or just text + Based on `FHIR CodeableConcept `_. + + :ivar coding: Code defined by a terminology system. + :vartype coding: list[~azure.healthinsights.patienttimeline.models.Coding] + :ivar text: Plain text representation of the concept. + :vartype text: str + """ + + coding: Optional[List["_models.Coding"]] = rest_field() + """Code defined by a terminology system.""" + text: Optional[str] = rest_field() + """Plain text representation of the concept.""" + + @overload + def __init__( + self, + *, + coding: Optional[List["_models.Coding"]] = None, + text: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Coding(Element): + """A Coding is a representation of a defined concept using a symbol from a defined "code system". + Based on `FHIR Coding `_. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar system: Identity of the terminology system. + :vartype system: str + :ivar version: Version of the system - if relevant. + :vartype version: str + :ivar code: Symbol in syntax defined by the system. + :vartype code: str + :ivar display: Representation defined by the system. + :vartype display: str + """ + + system: Optional[str] = rest_field() + """Identity of the terminology system.""" + version: Optional[str] = rest_field() + """Version of the system - if relevant.""" + code: Optional[str] = rest_field() + """Symbol in syntax defined by the system.""" + display: Optional[str] = rest_field() + """Representation defined by the system.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + system: Optional[str] = None, + version: Optional[str] = None, + code: Optional[str] = None, + display: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Resource(_model_base.Model): + """Resource is the ancestor of DomainResource from which most resources are derived. Bundle, + Parameters, and Binary extend Resource directly. + Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html. + + All required parameters must be populated in order to send to server. + + :ivar resource_type: The type of resource. Required. + :vartype resource_type: str + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.patienttimeline.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + """ + + resource_type: str = rest_field(name="resourceType") + """The type of resource. Required.""" + id: Optional[str] = rest_field() + """Resource Id.""" + meta: Optional["_models.Meta"] = rest_field() + """Metadata about the resource.""" + implicit_rules: Optional[str] = rest_field(name="implicitRules") + """A set of rules under which this content was created.""" + language: Optional[str] = rest_field() + """Language of the resource content.""" + + @overload + def __init__( + self, + *, + resource_type: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DomainResource(Resource): + """A resource with narrative, extensions, and contained resources + Based on `FHIR DomainResource `_. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + Condition, Observation, ResearchStudy + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.patienttimeline.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.patienttimeline.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.patienttimeline.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar resource_type: Required. Default value is None. + :vartype resource_type: str + """ + + __mapping__: Dict[str, _model_base.Model] = {} + text: Optional["_models.Narrative"] = rest_field() + """Text summary of the resource, for human interpretation.""" + contained: Optional[List["_models.Resource"]] = rest_field() + """Contained, inline Resources.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + modifier_extension: Optional[List["_models.Extension"]] = rest_field(name="modifierExtension") + """Extensions that cannot be ignored.""" + resource_type: Literal[None] = rest_discriminator(name="resourceType") + """Required. Default value is None.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.resource_type: Literal[None] = None + + +class Condition(DomainResource, discriminator="Condition"): # pylint: disable=too-many-instance-attributes + """Detailed information about conditions, problems or diagnoses + Based on `FHIR Condition `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.patienttimeline.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.patienttimeline.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.patienttimeline.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "Condition". + :vartype resource_type: str + :ivar identifier: External Ids for this condition. + :vartype identifier: list[~azure.healthinsights.patienttimeline.models.Identifier] + :ivar clinical_status: active | recurrence | relapse | inactive | remission | resolved. + :vartype clinical_status: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar verification_status: unconfirmed | provisional | differential | confirmed | refuted | + entered-in-error. + :vartype verification_status: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar category: problem-list-item | encounter-diagnosis. + :vartype category: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar severity: Subjective severity of condition. + :vartype severity: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar code: Identification of the condition, problem or diagnosis. + :vartype code: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar body_site: Anatomical location, if relevant. + :vartype body_site: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar encounter: Encounter created as part of. + :vartype encounter: ~azure.healthinsights.patienttimeline.models.Reference + :ivar onset_date_time: Estimated or actual date, date-time, or age. + :vartype onset_date_time: str + :ivar onset_age: Estimated or actual date, date-time, or age. + :vartype onset_age: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar onset_period: Estimated or actual date, date-time, or age. + :vartype onset_period: ~azure.healthinsights.patienttimeline.models.Period + :ivar onset_range: Estimated or actual date, date-time, or age. + :vartype onset_range: ~azure.healthinsights.patienttimeline.models.Range + :ivar onset_string: Estimated or actual date, date-time, or age. + :vartype onset_string: str + :ivar abatement_date_time: When in resolution/remission. + :vartype abatement_date_time: str + :ivar abatement_age: When in resolution/remission. + :vartype abatement_age: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar abatement_period: When in resolution/remission. + :vartype abatement_period: ~azure.healthinsights.patienttimeline.models.Period + :ivar abatement_range: When in resolution/remission. + :vartype abatement_range: ~azure.healthinsights.patienttimeline.models.Range + :ivar abatement_string: When in resolution/remission. + :vartype abatement_string: str + :ivar recorded_date: Date record was first recorded. + :vartype recorded_date: str + :ivar stage: stge/grade, usually assessed formally. + :vartype stage: list[~azure.healthinsights.patienttimeline.models.ConditionStage] + :ivar note: Additional information about the Condition. + :vartype note: list[~azure.healthinsights.patienttimeline.models.Annotation] + """ + + resource_type: Literal["Condition"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"Condition\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """External Ids for this condition.""" + clinical_status: Optional["_models.CodeableConcept"] = rest_field(name="clinicalStatus") + """active | recurrence | relapse | inactive | remission | resolved.""" + verification_status: Optional["_models.CodeableConcept"] = rest_field(name="verificationStatus") + """unconfirmed | provisional | differential | confirmed | refuted | entered-in-error.""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """problem-list-item | encounter-diagnosis.""" + severity: Optional["_models.CodeableConcept"] = rest_field() + """Subjective severity of condition.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Identification of the condition, problem or diagnosis.""" + body_site: Optional[List["_models.CodeableConcept"]] = rest_field(name="bodySite") + """Anatomical location, if relevant.""" + encounter: Optional["_models.Reference"] = rest_field() + """Encounter created as part of.""" + onset_date_time: Optional[str] = rest_field(name="onsetDateTime") + """Estimated or actual date, date-time, or age.""" + onset_age: Optional["_models.Quantity"] = rest_field(name="onsetAge") + """Estimated or actual date, date-time, or age.""" + onset_period: Optional["_models.Period"] = rest_field(name="onsetPeriod") + """Estimated or actual date, date-time, or age.""" + onset_range: Optional["_models.Range"] = rest_field(name="onsetRange") + """Estimated or actual date, date-time, or age.""" + onset_string: Optional[str] = rest_field(name="onsetString") + """Estimated or actual date, date-time, or age.""" + abatement_date_time: Optional[str] = rest_field(name="abatementDateTime") + """When in resolution/remission.""" + abatement_age: Optional["_models.Quantity"] = rest_field(name="abatementAge") + """When in resolution/remission.""" + abatement_period: Optional["_models.Period"] = rest_field(name="abatementPeriod") + """When in resolution/remission.""" + abatement_range: Optional["_models.Range"] = rest_field(name="abatementRange") + """When in resolution/remission.""" + abatement_string: Optional[str] = rest_field(name="abatementString") + """When in resolution/remission.""" + recorded_date: Optional[str] = rest_field(name="recordedDate") + """Date record was first recorded.""" + stage: Optional[List["_models.ConditionStage"]] = rest_field() + """stge/grade, usually assessed formally.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Additional information about the Condition.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + clinical_status: Optional["_models.CodeableConcept"] = None, + verification_status: Optional["_models.CodeableConcept"] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + severity: Optional["_models.CodeableConcept"] = None, + code: Optional["_models.CodeableConcept"] = None, + body_site: Optional[List["_models.CodeableConcept"]] = None, + encounter: Optional["_models.Reference"] = None, + onset_date_time: Optional[str] = None, + onset_age: Optional["_models.Quantity"] = None, + onset_period: Optional["_models.Period"] = None, + onset_range: Optional["_models.Range"] = None, + onset_string: Optional[str] = None, + abatement_date_time: Optional[str] = None, + abatement_age: Optional["_models.Quantity"] = None, + abatement_period: Optional["_models.Period"] = None, + abatement_range: Optional["_models.Range"] = None, + abatement_string: Optional[str] = None, + recorded_date: Optional[str] = None, + stage: Optional[List["_models.ConditionStage"]] = None, + note: Optional[List["_models.Annotation"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.resource_type: Literal["Condition"] = "Condition" + + +class ConditionStage(_model_base.Model): + """Stage/grade, usually assessed formally + Based on `FHIR Condition.Stage `_. + + :ivar summary: Simple summary (disease specific). + :vartype summary: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar type: Kind of staging. + :vartype type: ~azure.healthinsights.patienttimeline.models.CodeableConcept + """ + + summary: Optional["_models.CodeableConcept"] = rest_field() + """Simple summary (disease specific).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Kind of staging.""" + + @overload + def __init__( + self, + *, + summary: Optional["_models.CodeableConcept"] = None, + type: Optional["_models.CodeableConcept"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ContactDetail(Element): + """Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail). + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar name: Name of an individual to contact. + :vartype name: str + :ivar telecom: Contact details for individual or organization. + :vartype telecom: list[~azure.healthinsights.patienttimeline.models.ContactPoint] + """ + + name: Optional[str] = rest_field() + """Name of an individual to contact.""" + telecom: Optional[List["_models.ContactPoint"]] = rest_field() + """Contact details for individual or organization.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + name: Optional[str] = None, + telecom: Optional[List["_models.ContactPoint"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ContactPoint(_model_base.Model): + """Details for all kinds of technology mediated contact points for a person or organization, + including telephone, email, etc. + See https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint. + + :ivar system: phone | fax | email | pager | url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and "other". + :vartype system: str or ~azure.healthinsights.patienttimeline.models.ContactPointSystem + :ivar value: The actual contact point details. + :vartype value: str + :ivar use: home | work | temp | old | mobile - purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + :vartype use: str or ~azure.healthinsights.patienttimeline.models.ContactPointUse + :ivar rank: Specify preferred order of use (1 = highest). + :vartype rank: int + :ivar period: Time period when the contact point was/is in use. + :vartype period: ~azure.healthinsights.patienttimeline.models.Period + """ + + system: Optional[Union[str, "_models.ContactPointSystem"]] = rest_field() + """phone | fax | email | pager | url | sms | other. Known values are: \"phone\", \"fax\", + \"email\", \"pager\", \"url\", \"sms\", and \"other\".""" + value: Optional[str] = rest_field() + """The actual contact point details.""" + use: Optional[Union[str, "_models.ContactPointUse"]] = rest_field() + """home | work | temp | old | mobile - purpose of this contact point. Known values are: \"home\", + \"work\", \"temp\", \"old\", and \"mobile\".""" + rank: Optional[int] = rest_field() + """Specify preferred order of use (1 = highest).""" + period: Optional["_models.Period"] = rest_field() + """Time period when the contact point was/is in use.""" + + @overload + def __init__( + self, + *, + system: Optional[Union[str, "_models.ContactPointSystem"]] = None, + value: Optional[str] = None, + use: Optional[Union[str, "_models.ContactPointUse"]] = None, + rank: Optional[int] = None, + period: Optional["_models.Period"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAdministrativeMetadata(_model_base.Model): + """Document administrative metadata. + + :ivar ordered_procedures: List of procedure information associated with the document. + :vartype ordered_procedures: + list[~azure.healthinsights.patienttimeline.models.OrderedProcedure] + :ivar encounter_id: Reference to the encounter associated with the document. + :vartype encounter_id: str + """ + + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = rest_field(name="orderedProcedures") + """List of procedure information associated with the document.""" + encounter_id: Optional[str] = rest_field(name="encounterId") + """Reference to the encounter associated with the document.""" + + @overload + def __init__( + self, + *, + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = None, + encounter_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAuthor(_model_base.Model): + """Document author. + + :ivar id: author id. + :vartype id: str + :ivar full_name: Text representation of the full name. + :vartype full_name: str + """ + + id: Optional[str] = rest_field() + """author id.""" + full_name: Optional[str] = rest_field(name="fullName") + """Text representation of the full name.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + full_name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentContent(_model_base.Model): + """The content of the patient document. + + All required parameters must be populated in order to send to server. + + :ivar source_type: The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: "inline" and "reference". + :vartype source_type: str or + ~azure.healthinsights.patienttimeline.models.DocumentContentSourceType + :ivar value: The content of the document, given either inline (as a string) or as a reference + (URI). Required. + :vartype value: str + """ + + source_type: Union[str, "_models.DocumentContentSourceType"] = rest_field(name="sourceType") + """The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: \"inline\" and \"reference\".""" + value: str = rest_field() + """The content of the document, given either inline (as a string) or as a reference (URI). + Required.""" + + @overload + def __init__( + self, + *, + source_type: Union[str, "_models.DocumentContentSourceType"], + value: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Encounter(_model_base.Model): + """visit/encounter information. + + All required parameters must be populated in order to send to server. + + :ivar id: The id of the visit. Required. + :vartype id: str + :ivar period: Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end + to indicate the discharge time. + :vartype period: ~azure.healthinsights.patienttimeline.models.TimePeriod + :ivar class_property: The class of the encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + :vartype class_property: str or ~azure.healthinsights.patienttimeline.models.EncounterClass + """ + + id: str = rest_field() + """The id of the visit. Required.""" + period: Optional["_models.TimePeriod"] = rest_field() + """Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to + indicate the discharge time.""" + class_property: Optional[Union[str, "_models.EncounterClass"]] = rest_field(name="class") + """The class of the encounter. Known values are: \"inpatient\", \"ambulatory\", \"observation\", + \"emergency\", \"virtual\", and \"healthHome\".""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + period: Optional["_models.TimePeriod"] = None, + class_property: Optional[Union[str, "_models.EncounterClass"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Error(_model_base.Model): + """The error object. + + All required parameters must be populated in order to send to server. + + :ivar code: One of a server-defined set of error codes. Required. + :vartype code: str + :ivar message: A human-readable representation of the error. Required. + :vartype message: str + :ivar target: The target of the error. + :vartype target: str + :ivar details: An array of details about specific errors that led to this reported error. + :vartype details: list[~azure.healthinsights.patienttimeline.models.Error] + :ivar innererror: An object containing more specific information than the current object about + the error. + :vartype innererror: ~azure.healthinsights.patienttimeline.models.InnerError + """ + + code: str = rest_field() + """One of a server-defined set of error codes. Required.""" + message: str = rest_field() + """A human-readable representation of the error. Required.""" + target: Optional[str] = rest_field() + """The target of the error.""" + details: Optional[List["_models.Error"]] = rest_field() + """An array of details about specific errors that led to this reported error.""" + innererror: Optional["_models.InnerError"] = rest_field() + """An object containing more specific information than the current object about the error.""" + + @overload + def __init__( + self, + *, + code: str, + message: str, + target: Optional[str] = None, + details: Optional[List["_models.Error"]] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Extension(Element): # pylint: disable=too-many-instance-attributes + """Base for all elements + Based on `FHIR Element `_. + + All required parameters must be populated in order to send to server. + + :ivar url: Source of the definition for the extension code - a logical name or a URL. Required. + :vartype url: str + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.patienttimeline.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.patienttimeline.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.patienttimeline.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.patienttimeline.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.patienttimeline.models.Reference + """ + + url: str = rest_field() + """Source of the definition for the extension code - a logical name or a URL. Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + + @overload + def __init__( + self, + *, + url: str, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class HealthInsightsOperationStatus(_model_base.Model): + """Provides status details for long running operations. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: The unique ID of the operation. Required. + :vartype id: str + :ivar status: The status of the operation. Required. Known values are: "notStarted", "running", + "succeeded", "failed", and "canceled". + :vartype status: str or ~azure.healthinsights.patienttimeline.models.JobStatus + :ivar created_date_time: The date and time when the processing job was created. + :vartype created_date_time: ~datetime.datetime + :ivar expiration_date_time: The date and time when the processing job is set to expire. + :vartype expiration_date_time: ~datetime.datetime + :ivar last_update_date_time: The date and time when the processing job was last updated. + :vartype last_update_date_time: ~datetime.datetime + :ivar error: Error object that describes the error when status is "Failed". + :vartype error: ~azure.healthinsights.patienttimeline.models.Error + :ivar result: The result of the operation. + :vartype result: ~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult + """ + + id: str = rest_field(visibility=["read"]) + """The unique ID of the operation. Required.""" + status: Union[str, "_models.JobStatus"] = rest_field(visibility=["read"]) + """The status of the operation. Required. Known values are: \"notStarted\", \"running\", + \"succeeded\", \"failed\", and \"canceled\".""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was created.""" + expiration_date_time: Optional[datetime.datetime] = rest_field( + name="expirationDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job is set to expire.""" + last_update_date_time: Optional[datetime.datetime] = rest_field( + name="lastUpdateDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was last updated.""" + error: Optional["_models.Error"] = rest_field() + """Error object that describes the error when status is \"Failed\".""" + result: Optional["_models.PatientTimelineInferenceResult"] = rest_field() + """The result of the operation.""" + + @overload + def __init__( + self, + *, + error: Optional["_models.Error"] = None, + result: Optional["_models.PatientTimelineInferenceResult"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Identifier(Element): + """An identifier intended for computation + Based on `FHIR Identifier `_. + + :ivar use: usual | official | temp | secondary | old (If known). + :vartype use: str + :ivar type: Description of identifier. + :vartype type: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar system: The namespace for the identifier value. + :vartype system: str + :ivar value: The value that is unique. + :vartype value: str + :ivar period: Time period when id is/was valid for use. + :vartype period: ~azure.healthinsights.patienttimeline.models.Period + :ivar assigner: Organization that issued id (may be just text). + :vartype assigner: ~azure.healthinsights.patienttimeline.models.Reference + """ + + use: Optional[str] = rest_field() + """usual | official | temp | secondary | old (If known).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Description of identifier.""" + system: Optional[str] = rest_field() + """The namespace for the identifier value.""" + value: Optional[str] = rest_field() + """The value that is unique.""" + period: Optional["_models.Period"] = rest_field() + """Time period when id is/was valid for use.""" + assigner: Optional["_models.Reference"] = rest_field() + """Organization that issued id (may be just text).""" + + @overload + def __init__( + self, + *, + use: Optional[str] = None, + type: Optional["_models.CodeableConcept"] = None, + system: Optional[str] = None, + value: Optional[str] = None, + period: Optional["_models.Period"] = None, + assigner: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class InnerError(_model_base.Model): + """An object containing more specific information about the error. As per Microsoft One API + guidelines - + https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + + :ivar code: One of a server-defined set of error codes. + :vartype code: str + :ivar innererror: Inner error. + :vartype innererror: ~azure.healthinsights.patienttimeline.models.InnerError + """ + + code: Optional[str] = rest_field() + """One of a server-defined set of error codes.""" + innererror: Optional["_models.InnerError"] = rest_field() + """Inner error.""" + + @overload + def __init__( + self, + *, + code: Optional[str] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Meta(_model_base.Model): + """Metadata about a resource + Based on `FHIR Meta `_. + + :ivar version_id: The version specific identifier, as it appears in the version portion of the + URL. This value changes when the resource is created, updated, or deleted. + :vartype version_id: str + :ivar last_updated: When the resource last changed - e.g. when the version changed. + :vartype last_updated: str + :ivar source: A uri that identifies the source system of the resource. This provides a minimal + amount of Provenance information that can be used to track or differentiate the source of + information in the resource. The source may identify another FHIR server, document, message, + database, etc. + :vartype source: str + :ivar profile: A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_. + :vartype profile: list[str] + :ivar security: Security labels applied to this resource. These tags connect specific resources + to the overall security policy and infrastructure. + :vartype security: list[~azure.healthinsights.patienttimeline.models.Coding] + :ivar tag: Tags applied to this resource. Tags are intended to be used to identify and relate + resources to process and workflow, and applications are not required to consider the tags when + interpreting the meaning of a resource. + :vartype tag: list[~azure.healthinsights.patienttimeline.models.Coding] + """ + + version_id: Optional[str] = rest_field(name="versionId") + """The version specific identifier, as it appears in the version portion of the URL. This value + changes when the resource is created, updated, or deleted.""" + last_updated: Optional[str] = rest_field(name="lastUpdated") + """When the resource last changed - e.g. when the version changed.""" + source: Optional[str] = rest_field() + """A uri that identifies the source system of the resource. This provides a minimal amount of + Provenance information that can be used to track or differentiate the source of information in + the resource. The source may identify another FHIR server, document, message, database, etc.""" + profile: Optional[List[str]] = rest_field() + """A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_.""" + security: Optional[List["_models.Coding"]] = rest_field() + """Security labels applied to this resource. These tags connect specific resources to the overall + security policy and infrastructure.""" + tag: Optional[List["_models.Coding"]] = rest_field() + """Tags applied to this resource. Tags are intended to be used to identify and relate resources to + process and workflow, and applications are not required to consider the tags when interpreting + the meaning of a resource.""" + + @overload + def __init__( + self, + *, + version_id: Optional[str] = None, + last_updated: Optional[str] = None, + source: Optional[str] = None, + profile: Optional[List[str]] = None, + security: Optional[List["_models.Coding"]] = None, + tag: Optional[List["_models.Coding"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Narrative(Element): + """Any resource that is a `DomainResource `_ may + include a human-readable narrative that contains a summary of the resource and may be used to + represent the content of the resource to a human. + Based on `FHIR Narrative `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar status: generated, extensions, additional, empty. Required. + :vartype status: str + :ivar div: xhtml. Required. + :vartype div: str + """ + + status: str = rest_field() + """generated, extensions, additional, empty. Required.""" + div: str = rest_field() + """xhtml. Required.""" + + @overload + def __init__( + self, + *, + status: str, + div: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Observation(DomainResource, discriminator="Observation"): # pylint: disable=too-many-instance-attributes + """Detailed information about observations + Based on `FHIR Observation `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.patienttimeline.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.patienttimeline.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.patienttimeline.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "Observation". + :vartype resource_type: str + :ivar identifier: Business Identifier for observation. + :vartype identifier: list[~azure.healthinsights.patienttimeline.models.Identifier] + :ivar status: registered | preliminary | final | amended +. Required. Known values are: + "registered", "preliminary", "final", "amended", "corrected", "cancelled", "entered-in-error", + and "unknown". + :vartype status: str or ~azure.healthinsights.patienttimeline.models.ObservationStatusCodeType + :ivar category: Classification of type of observation. + :vartype category: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar code: Type of observation (code / type). Required. + :vartype code: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar subject: Who and/or what the observation is about. + :vartype subject: ~azure.healthinsights.patienttimeline.models.Reference + :ivar encounter: Healthcare event during which this observation is made. + :vartype encounter: ~azure.healthinsights.patienttimeline.models.Reference + :ivar effective_date_time: Clinically relevant time/time-period for observation. + :vartype effective_date_time: str + :ivar effective_period: Clinically relevant time/time-period for observation. + :vartype effective_period: ~azure.healthinsights.patienttimeline.models.Period + :ivar effective_instant: Clinically relevant time/time-period for observation. + :vartype effective_instant: str + :ivar issued: Date/Time this version was made available. + :vartype issued: str + :ivar value_quantity: Actual result. + :vartype value_quantity: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar value_codeable_concept: Actual result. + :vartype value_codeable_concept: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar value_string: Actual result. + :vartype value_string: str + :ivar value_boolean: Actual result. + :vartype value_boolean: bool + :ivar value_integer: Actual result. + :vartype value_integer: int + :ivar value_range: Actual result. + :vartype value_range: ~azure.healthinsights.patienttimeline.models.Range + :ivar value_ratio: Actual result. + :vartype value_ratio: ~azure.healthinsights.patienttimeline.models.Ratio + :ivar value_sampled_data: Actual result. + :vartype value_sampled_data: ~azure.healthinsights.patienttimeline.models.SampledData + :ivar value_time: Actual result. + :vartype value_time: ~datetime.time + :ivar value_date_time: Actual result. + :vartype value_date_time: str + :ivar value_period: Actual result. + :vartype value_period: ~azure.healthinsights.patienttimeline.models.Period + :ivar data_absent_reason: Why the result is missing. + :vartype data_absent_reason: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar interpretation: High, low, normal, etc. + :vartype interpretation: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar note: Comments about the observation. + :vartype note: list[~azure.healthinsights.patienttimeline.models.Annotation] + :ivar body_site: Observed body part. + :vartype body_site: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar method: How it was done. + :vartype method: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar reference_range: Provides guide for interpretation. + :vartype reference_range: + list[~azure.healthinsights.patienttimeline.models.ObservationReferenceRange] + :ivar has_member: Related resource that belongs to the Observation group. + :vartype has_member: list[~azure.healthinsights.patienttimeline.models.Reference] + :ivar derived_from: Related measurements the observation is made from. + :vartype derived_from: list[~azure.healthinsights.patienttimeline.models.Reference] + :ivar component: Component results. + :vartype component: list[~azure.healthinsights.patienttimeline.models.ObservationComponent] + """ + + resource_type: Literal["Observation"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"Observation\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """Business Identifier for observation.""" + status: Union[str, "_models.ObservationStatusCodeType"] = rest_field() + """registered | preliminary | final | amended +. Required. Known values are: \"registered\", + \"preliminary\", \"final\", \"amended\", \"corrected\", \"cancelled\", \"entered-in-error\", + and \"unknown\".""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """Classification of type of observation.""" + code: "_models.CodeableConcept" = rest_field() + """Type of observation (code / type). Required.""" + subject: Optional["_models.Reference"] = rest_field() + """Who and/or what the observation is about.""" + encounter: Optional["_models.Reference"] = rest_field() + """Healthcare event during which this observation is made.""" + effective_date_time: Optional[str] = rest_field(name="effectiveDateTime") + """Clinically relevant time/time-period for observation.""" + effective_period: Optional["_models.Period"] = rest_field(name="effectivePeriod") + """Clinically relevant time/time-period for observation.""" + effective_instant: Optional[str] = rest_field(name="effectiveInstant") + """Clinically relevant time/time-period for observation.""" + issued: Optional[str] = rest_field() + """Date/Time this version was made available.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Actual result.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Actual result.""" + value_string: Optional[str] = rest_field(name="valueString") + """Actual result.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Actual result.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Actual result.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Actual result.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Actual result.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Actual result.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Actual result.""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Actual result.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Actual result.""" + data_absent_reason: Optional["_models.CodeableConcept"] = rest_field(name="dataAbsentReason") + """Why the result is missing.""" + interpretation: Optional[List["_models.CodeableConcept"]] = rest_field() + """High, low, normal, etc.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Comments about the observation.""" + body_site: Optional["_models.CodeableConcept"] = rest_field(name="bodySite") + """Observed body part.""" + method: Optional["_models.CodeableConcept"] = rest_field() + """How it was done.""" + reference_range: Optional[List["_models.ObservationReferenceRange"]] = rest_field(name="referenceRange") + """Provides guide for interpretation.""" + has_member: Optional[List["_models.Reference"]] = rest_field(name="hasMember") + """Related resource that belongs to the Observation group.""" + derived_from: Optional[List["_models.Reference"]] = rest_field(name="derivedFrom") + """Related measurements the observation is made from.""" + component: Optional[List["_models.ObservationComponent"]] = rest_field() + """Component results.""" + + @overload + def __init__( + self, + *, + status: Union[str, "_models.ObservationStatusCodeType"], + code: "_models.CodeableConcept", + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + subject: Optional["_models.Reference"] = None, + encounter: Optional["_models.Reference"] = None, + effective_date_time: Optional[str] = None, + effective_period: Optional["_models.Period"] = None, + effective_instant: Optional[str] = None, + issued: Optional[str] = None, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + data_absent_reason: Optional["_models.CodeableConcept"] = None, + interpretation: Optional[List["_models.CodeableConcept"]] = None, + note: Optional[List["_models.Annotation"]] = None, + body_site: Optional["_models.CodeableConcept"] = None, + method: Optional["_models.CodeableConcept"] = None, + reference_range: Optional[List["_models.ObservationReferenceRange"]] = None, + has_member: Optional[List["_models.Reference"]] = None, + derived_from: Optional[List["_models.Reference"]] = None, + component: Optional[List["_models.ObservationComponent"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.resource_type: Literal["Observation"] = "Observation" + + +class ObservationComponent(Element): # pylint: disable=too-many-instance-attributes + """Component results + Based on `FHIR Observation.component `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar code: Type of component observation (code / type). Required. + :vartype code: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.patienttimeline.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.patienttimeline.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.patienttimeline.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.patienttimeline.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.patienttimeline.models.Reference + :ivar data_absent_reason: Why the component result is missing. + :vartype data_absent_reason: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar interpretation: High, low, normal, etc. + :vartype interpretation: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar reference_range: Provides guide for interpretation of component result. + :vartype reference_range: + list[~azure.healthinsights.patienttimeline.models.ObservationReferenceRange] + """ + + code: "_models.CodeableConcept" = rest_field() + """Type of component observation (code / type). Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + data_absent_reason: Optional["_models.CodeableConcept"] = rest_field(name="dataAbsentReason") + """Why the component result is missing.""" + interpretation: Optional[List["_models.CodeableConcept"]] = rest_field() + """High, low, normal, etc.""" + reference_range: Optional[List["_models.ObservationReferenceRange"]] = rest_field(name="referenceRange") + """Provides guide for interpretation of component result.""" + + @overload + def __init__( + self, + *, + code: "_models.CodeableConcept", + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + data_absent_reason: Optional["_models.CodeableConcept"] = None, + interpretation: Optional[List["_models.CodeableConcept"]] = None, + reference_range: Optional[List["_models.ObservationReferenceRange"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ObservationReferenceRange(_model_base.Model): + """Provides guide for interpretation of component result + Based on `FHIR Observation.referenceRange `_. + + :ivar low: Low Range, if relevant. + :vartype low: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar high: High Range, if relevant. + :vartype high: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar type: Reference range qualifier. + :vartype type: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar applies_to: Reference range population. + :vartype applies_to: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar age: Applicable age range, if relevant. + :vartype age: ~azure.healthinsights.patienttimeline.models.Range + :ivar text: Text based reference range in an observation. + :vartype text: str + """ + + low: Optional["_models.Quantity"] = rest_field() + """Low Range, if relevant.""" + high: Optional["_models.Quantity"] = rest_field() + """High Range, if relevant.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Reference range qualifier.""" + applies_to: Optional[List["_models.CodeableConcept"]] = rest_field(name="appliesTo") + """Reference range population.""" + age: Optional["_models.Range"] = rest_field() + """Applicable age range, if relevant.""" + text: Optional[str] = rest_field() + """Text based reference range in an observation.""" + + @overload + def __init__( + self, + *, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, + type: Optional["_models.CodeableConcept"] = None, + applies_to: Optional[List["_models.CodeableConcept"]] = None, + age: Optional["_models.Range"] = None, + text: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OrderedProcedure(_model_base.Model): + """Procedure information. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar code: Procedure code. + :vartype code: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar description: Procedure description. + :vartype description: str + """ + + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Procedure code.""" + description: Optional[str] = rest_field() + """Procedure description.""" + + @overload + def __init__( + self, + *, + extension: Optional[List["_models.Extension"]] = None, + code: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientDetails(_model_base.Model): + """Patient structured information, including demographics and known structured clinical + information. + + :ivar sex: The patient's sex. Known values are: "female", "male", and "unspecified". + :vartype sex: str or ~azure.healthinsights.patienttimeline.models.PatientSex + :ivar birth_date: The patient's date of birth. + :vartype birth_date: ~datetime.date + :ivar clinical_info: Known clinical information for the patient, structured. + :vartype clinical_info: list[~azure.healthinsights.patienttimeline.models.Resource] + """ + + sex: Optional[Union[str, "_models.PatientSex"]] = rest_field() + """The patient's sex. Known values are: \"female\", \"male\", and \"unspecified\".""" + birth_date: Optional[datetime.date] = rest_field(name="birthDate") + """The patient's date of birth.""" + clinical_info: Optional[List["_models.Resource"]] = rest_field(name="clinicalInfo") + """Known clinical information for the patient, structured.""" + + @overload + def __init__( + self, + *, + sex: Optional[Union[str, "_models.PatientSex"]] = None, + birth_date: Optional[datetime.date] = None, + clinical_info: Optional[List["_models.Resource"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientDocument(_model_base.Model): + """A clinical document related to a patient. Document here is in the wide sense - not just a text + document (note). + + All required parameters must be populated in order to send to server. + + :ivar type: The type of the patient document, such as 'note' (text document) or 'fhirBundle' + (FHIR JSON document). Required. Known values are: "note", "fhirBundle", "dicom", and + "genomicSequencing". + :vartype type: str or ~azure.healthinsights.patienttimeline.models.DocumentType + :ivar clinical_type: The type of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", "procedure", "progress", + "laboratory", and "pathologyReport". + :vartype clinical_type: str or + ~azure.healthinsights.patienttimeline.models.ClinicalDocumentType + :ivar id: A given identifier for the document. Has to be unique across all documents for a + single patient. Required. + :vartype id: str + :ivar language: A 2 letter ISO 639-1 representation of the language of the document. + :vartype language: str + :ivar created_date_time: The date and time when the document was created. + :vartype created_date_time: ~datetime.datetime + :ivar authors: Document author(s). + :vartype authors: list[~azure.healthinsights.patienttimeline.models.DocumentAuthor] + :ivar specialty_type: specialty type the document. Known values are: "pathology" and + "radiology". + :vartype specialty_type: str or ~azure.healthinsights.patienttimeline.models.SpecialtyType + :ivar administrative_metadata: Administrative metadata for the document. + :vartype administrative_metadata: + ~azure.healthinsights.patienttimeline.models.DocumentAdministrativeMetadata + :ivar content: The content of the patient document. Required. + :vartype content: ~azure.healthinsights.patienttimeline.models.DocumentContent + """ + + type: Union[str, "_models.DocumentType"] = rest_field() + """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON + document). Required. Known values are: \"note\", \"fhirBundle\", \"dicom\", and + \"genomicSequencing\".""" + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = rest_field(name="clinicalType") + """The type of the clinical document. Known values are: \"consultation\", \"dischargeSummary\", + \"historyAndPhysical\", \"radiologyReport\", \"procedure\", \"progress\", \"laboratory\", and + \"pathologyReport\".""" + id: str = rest_field() + """A given identifier for the document. Has to be unique across all documents for a single + patient. Required.""" + language: Optional[str] = rest_field() + """A 2 letter ISO 639-1 representation of the language of the document.""" + created_date_time: Optional[datetime.datetime] = rest_field(name="createdDateTime", format="rfc3339") + """The date and time when the document was created.""" + authors: Optional[List["_models.DocumentAuthor"]] = rest_field() + """Document author(s).""" + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = rest_field(name="specialtyType") + """specialty type the document. Known values are: \"pathology\" and \"radiology\".""" + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = rest_field( + name="administrativeMetadata" + ) + """Administrative metadata for the document.""" + content: "_models.DocumentContent" = rest_field() + """The content of the patient document. Required.""" + + @overload + def __init__( + self, + *, + type: Union[str, "_models.DocumentType"], + id: str, # pylint: disable=redefined-builtin + content: "_models.DocumentContent", + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = None, + language: Optional[str] = None, + created_date_time: Optional[datetime.datetime] = None, + authors: Optional[List["_models.DocumentAuthor"]] = None, + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = None, + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientRecord(_model_base.Model): + """A patient record, including their clinical information and data. + + All required parameters must be populated in order to send to server. + + :ivar id: A given identifier for the patient. Has to be unique across all patients in a single + request. Required. + :vartype id: str + :ivar info: Patient structured information, including demographics and known structured + clinical information. + :vartype info: ~azure.healthinsights.patienttimeline.models.PatientDetails + :ivar encounters: Patient encounters/visits. + :vartype encounters: list[~azure.healthinsights.patienttimeline.models.Encounter] + :ivar patient_documents: Patient unstructured clinical data, given as documents. + :vartype patient_documents: list[~azure.healthinsights.patienttimeline.models.PatientDocument] + """ + + id: str = rest_field() + """A given identifier for the patient. Has to be unique across all patients in a single request. + Required.""" + info: Optional["_models.PatientDetails"] = rest_field() + """Patient structured information, including demographics and known structured clinical + information.""" + encounters: Optional[List["_models.Encounter"]] = rest_field() + """Patient encounters/visits.""" + patient_documents: Optional[List["_models.PatientDocument"]] = rest_field(name="patientDocuments") + """Patient unstructured clinical data, given as documents.""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + info: Optional["_models.PatientDetails"] = None, + encounters: Optional[List["_models.Encounter"]] = None, + patient_documents: Optional[List["_models.PatientDocument"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientTimelineData(_model_base.Model): + """The body of the Patient Timeline request. + + All required parameters must be populated in order to send to server. + + :ivar patients: The list of patients, including their clinical information and data. Required. + :vartype patients: list[~azure.healthinsights.patienttimeline.models.PatientRecord] + :ivar configuration: Configuration affecting the Patient Timeline model's inference. + :vartype configuration: + ~azure.healthinsights.patienttimeline.models.PatientTimelineModelConfiguration + """ + + patients: List["_models.PatientRecord"] = rest_field() + """The list of patients, including their clinical information and data. Required.""" + configuration: Optional["_models.PatientTimelineModelConfiguration"] = rest_field() + """Configuration affecting the Patient Timeline model's inference.""" + + @overload + def __init__( + self, + *, + patients: List["_models.PatientRecord"], + configuration: Optional["_models.PatientTimelineModelConfiguration"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientTimelineInference(_model_base.Model): + """An inference made by the Patient Timeline model regarding a patient. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar type: The type of the Patient Timeline inference. Required. Known values are: + "timelineEvent" and "summaryItem". + :vartype type: str or ~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceType + :ivar resource: FHIR 4.0 representation of the piece of clinical info. + additional dependent resources maybe contained (e.g. MedicationStatement may contain + Medication) + -- In the SDK we will have custom mapping to map this type to JsonObject. + :vartype resource: ~azure.healthinsights.patienttimeline.models.DomainResource + :ivar period: Time range relevant to this Timeline inference. + :vartype period: ~azure.healthinsights.patienttimeline.models.TimePeriod + """ + + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + type: Union[str, "_models.PatientTimelineInferenceType"] = rest_field() + """The type of the Patient Timeline inference. Required. Known values are: \"timelineEvent\" and + \"summaryItem\".""" + resource: Optional["_models.DomainResource"] = rest_field() + """FHIR 4.0 representation of the piece of clinical info. + additional dependent resources maybe contained (e.g. MedicationStatement may contain + Medication) + -- In the SDK we will have custom mapping to map this type to JsonObject.""" + period: Optional["_models.TimePeriod"] = rest_field() + """Time range relevant to this Timeline inference.""" + + @overload + def __init__( + self, + *, + type: Union[str, "_models.PatientTimelineInferenceType"], + extension: Optional[List["_models.Extension"]] = None, + resource: Optional["_models.DomainResource"] = None, + period: Optional["_models.TimePeriod"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientTimelineInferenceResult(_model_base.Model): + """The inference results for the Patient Timeline request. + + All required parameters must be populated in order to send to server. + + :ivar patient_results: Results for the patients given in the request. Required. + :vartype patient_results: + list[~azure.healthinsights.patienttimeline.models.PatientTimelinePatientResult] + :ivar model_version: The version of the model used for inference, expressed as the model date. + Required. + :vartype model_version: str + """ + + patient_results: List["_models.PatientTimelinePatientResult"] = rest_field(name="patientResults") + """Results for the patients given in the request. Required.""" + model_version: str = rest_field(name="modelVersion") + """The version of the model used for inference, expressed as the model date. Required.""" + + @overload + def __init__( + self, + *, + patient_results: List["_models.PatientTimelinePatientResult"], + model_version: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientTimelineModelConfiguration(_model_base.Model): + """Configuration affecting the Patient Timeline model's inference. + + :ivar verbose: An indication whether the model should produce verbose output. + :vartype verbose: bool + :ivar include_evidence: An indication whether the model's output should include evidence for + the inferences. + :vartype include_evidence: bool + """ + + verbose: Optional[bool] = rest_field() + """An indication whether the model should produce verbose output.""" + include_evidence: Optional[bool] = rest_field(name="includeEvidence") + """An indication whether the model's output should include evidence for the inferences.""" + + @overload + def __init__( + self, + *, + verbose: Optional[bool] = None, + include_evidence: Optional[bool] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientTimelinePatientResult(_model_base.Model): + """The results of the model's work for a single patient. + + All required parameters must be populated in order to send to server. + + :ivar patient_id: The identifier given for the patient in the request. Required. + :vartype patient_id: str + :ivar inferences: The model's inferences for the given patient. Required. + :vartype inferences: + list[~azure.healthinsights.patienttimeline.models.PatientTimelineInference] + """ + + patient_id: str = rest_field(name="patientId") + """The identifier given for the patient in the request. Required.""" + inferences: List["_models.PatientTimelineInference"] = rest_field() + """The model's inferences for the given patient. Required.""" + + @overload + def __init__( + self, + *, + patient_id: str, + inferences: List["_models.PatientTimelineInference"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Period(Element): + """A time period defined by a start and end date and optionally time + Based on `FHIR Period `_. + + :ivar start: Starting time with inclusive boundary. + :vartype start: str + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: str + """ + + start: Optional[str] = rest_field() + """Starting time with inclusive boundary.""" + end: Optional[str] = rest_field() + """End time with inclusive boundary, if not ongoing.""" + + @overload + def __init__( + self, + *, + start: Optional[str] = None, + end: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Quantity(Element): + """A measured or measurable amount + Based on `FHIR Quantity `_. + + :ivar value: Numerical value (with implicit precision). + :vartype value: float + :ivar comparator: < | <= | >= | > - how to understand the value. + :vartype comparator: str + :ivar unit: Unit representation. + :vartype unit: str + :ivar system: System that defines coded unit form. + :vartype system: str + :ivar code: Coded form of the unit. + :vartype code: str + """ + + value: Optional[float] = rest_field() + """Numerical value (with implicit precision).""" + comparator: Optional[str] = rest_field() + """< | <= | >= | > - how to understand the value.""" + unit: Optional[str] = rest_field() + """Unit representation.""" + system: Optional[str] = rest_field() + """System that defines coded unit form.""" + code: Optional[str] = rest_field() + """Coded form of the unit.""" + + @overload + def __init__( + self, + *, + value: Optional[float] = None, + comparator: Optional[str] = None, + unit: Optional[str] = None, + system: Optional[str] = None, + code: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Range(Element): + """A set of ordered Quantities defined by a low and high limit + Based on `FHIR Range `_. + + :ivar low: Low limit. + :vartype low: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar high: High limit. + :vartype high: ~azure.healthinsights.patienttimeline.models.Quantity + """ + + low: Optional["_models.Quantity"] = rest_field() + """Low limit.""" + high: Optional["_models.Quantity"] = rest_field() + """High limit.""" + + @overload + def __init__( + self, + *, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Ratio(Element): + """A ratio of two Quantity values - a numerator and a denominator + Based on `FHIR Ratio `_. + + :ivar numerator: Numerator value. + :vartype numerator: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar denominator: Denominator value. + :vartype denominator: ~azure.healthinsights.patienttimeline.models.Quantity + """ + + numerator: Optional["_models.Quantity"] = rest_field() + """Numerator value.""" + denominator: Optional["_models.Quantity"] = rest_field() + """Denominator value.""" + + @overload + def __init__( + self, + *, + numerator: Optional["_models.Quantity"] = None, + denominator: Optional["_models.Quantity"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Reference(Element): + """A reference from one resource to another + Based on `FHIR Reference `_. + + :ivar reference: Literal reference, Relative, internal or absolute URL. + :vartype reference: str + :ivar type: Type the reference refers to (e.g. "Patient"). + :vartype type: str + :ivar identifier: Logical reference, when literal reference is not known. + :vartype identifier: ~azure.healthinsights.patienttimeline.models.Identifier + :ivar display: Text alternative for the resource. + :vartype display: str + """ + + reference: Optional[str] = rest_field() + """Literal reference, Relative, internal or absolute URL.""" + type: Optional[str] = rest_field() + """Type the reference refers to (e.g. \"Patient\").""" + identifier: Optional["_models.Identifier"] = rest_field() + """Logical reference, when literal reference is not known.""" + display: Optional[str] = rest_field() + """Text alternative for the resource.""" + + @overload + def __init__( + self, + *, + reference: Optional[str] = None, + type: Optional[str] = None, + identifier: Optional["_models.Identifier"] = None, + display: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResearchStudy(DomainResource, discriminator="ResearchStudy"): # pylint: disable=too-many-instance-attributes + """Detailed information about Research Study + Based on `FHIR ResearchStudy `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.patienttimeline.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.patienttimeline.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.patienttimeline.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "ResearchStudy". + :vartype resource_type: str + :ivar identifier: Business Identifier for study. + :vartype identifier: list[~azure.healthinsights.patienttimeline.models.Identifier] + :ivar title: Name for this study. + :vartype title: str + :ivar protocol: Steps followed in executing study. + :vartype protocol: list[~azure.healthinsights.patienttimeline.models.Reference] + :ivar part_of: Part of larger study. + :vartype part_of: list[~azure.healthinsights.patienttimeline.models.Reference] + :ivar status: active | administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | in-review | + temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", "administratively-completed", "approved", + "closed-to-accrual", "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", "temporarily-closed-to-accrual-and-intervention", + and "withdrawn". + :vartype status: str or + ~azure.healthinsights.patienttimeline.models.ResearchStudyStatusCodeType + :ivar primary_purpose_type: treatment | prevention | diagnostic | supportive-care | screening | + health-services-research | basic-science | device-feasibility. + :vartype primary_purpose_type: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar phase: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | + phase-3 | phase-4. + :vartype phase: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar category: Classifications for the study. + :vartype category: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar focus: Drugs, devices, etc. under study. + :vartype focus: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar condition: Condition being studied. + :vartype condition: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar contact: Contact details for the study. + :vartype contact: list[~azure.healthinsights.patienttimeline.models.ContactDetail] + :ivar keyword: Used to search for the study. + :vartype keyword: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar location: Geographic region(s) for study. + :vartype location: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar description: What this is study doing. + :vartype description: str + :ivar enrollment: Inclusion & exclusion criteria. + :vartype enrollment: list[~azure.healthinsights.patienttimeline.models.Reference] + :ivar period: When the study began and ended. + :vartype period: ~azure.healthinsights.patienttimeline.models.Period + :ivar sponsor: Organization that initiates and is legally responsible for the study. + :vartype sponsor: ~azure.healthinsights.patienttimeline.models.Reference + :ivar principal_investigator: Researcher who oversees multiple aspects of the study. + :vartype principal_investigator: ~azure.healthinsights.patienttimeline.models.Reference + :ivar site: Facility where study activities are conducted. + :vartype site: list[~azure.healthinsights.patienttimeline.models.Reference] + :ivar reason_stopped: accrual-goal-met | closed-due-to-toxicity | + closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design. + :vartype reason_stopped: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar note: Comments made about the study. + :vartype note: list[~azure.healthinsights.patienttimeline.models.Annotation] + :ivar arm: Defined path through the study for a subject. + :vartype arm: list[~azure.healthinsights.patienttimeline.models.ResearchStudyArm] + :ivar objective: A goal for the study. + :vartype objective: list[~azure.healthinsights.patienttimeline.models.ResearchStudyObjective] + """ + + resource_type: Literal["ResearchStudy"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"ResearchStudy\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """Business Identifier for study.""" + title: Optional[str] = rest_field() + """Name for this study.""" + protocol: Optional[List["_models.Reference"]] = rest_field() + """Steps followed in executing study.""" + part_of: Optional[List["_models.Reference"]] = rest_field(name="partOf") + """Part of larger study.""" + status: Union[str, "_models.ResearchStudyStatusCodeType"] = rest_field() + """active | administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | in-review | + temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: \"active\", \"administratively-completed\", \"approved\", + \"closed-to-accrual\", \"closed-to-accrual-and-intervention\", \"completed\", \"disapproved\", + \"in-review\", \"temporarily-closed-to-accrual\", + \"temporarily-closed-to-accrual-and-intervention\", and \"withdrawn\".""" + primary_purpose_type: Optional["_models.CodeableConcept"] = rest_field(name="primaryPurposeType") + """treatment | prevention | diagnostic | supportive-care | screening | health-services-research | + basic-science | device-feasibility.""" + phase: Optional["_models.CodeableConcept"] = rest_field() + """n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | + phase-4.""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """Classifications for the study.""" + focus: Optional[List["_models.CodeableConcept"]] = rest_field() + """Drugs, devices, etc. under study.""" + condition: Optional[List["_models.CodeableConcept"]] = rest_field() + """Condition being studied.""" + contact: Optional[List["_models.ContactDetail"]] = rest_field() + """Contact details for the study.""" + keyword: Optional[List["_models.CodeableConcept"]] = rest_field() + """Used to search for the study.""" + location: Optional[List["_models.CodeableConcept"]] = rest_field() + """Geographic region(s) for study.""" + description: Optional[str] = rest_field() + """What this is study doing.""" + enrollment: Optional[List["_models.Reference"]] = rest_field() + """Inclusion & exclusion criteria.""" + period: Optional["_models.Period"] = rest_field() + """When the study began and ended.""" + sponsor: Optional["_models.Reference"] = rest_field() + """Organization that initiates and is legally responsible for the study.""" + principal_investigator: Optional["_models.Reference"] = rest_field(name="principalInvestigator") + """Researcher who oversees multiple aspects of the study.""" + site: Optional[List["_models.Reference"]] = rest_field() + """Facility where study activities are conducted.""" + reason_stopped: Optional["_models.CodeableConcept"] = rest_field(name="reasonStopped") + """accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | + temporarily-closed-per-study-design.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Comments made about the study.""" + arm: Optional[List["_models.ResearchStudyArm"]] = rest_field() + """Defined path through the study for a subject.""" + objective: Optional[List["_models.ResearchStudyObjective"]] = rest_field() + """A goal for the study.""" + + @overload + def __init__( + self, + *, + status: Union[str, "_models.ResearchStudyStatusCodeType"], + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + title: Optional[str] = None, + protocol: Optional[List["_models.Reference"]] = None, + part_of: Optional[List["_models.Reference"]] = None, + primary_purpose_type: Optional["_models.CodeableConcept"] = None, + phase: Optional["_models.CodeableConcept"] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + focus: Optional[List["_models.CodeableConcept"]] = None, + condition: Optional[List["_models.CodeableConcept"]] = None, + contact: Optional[List["_models.ContactDetail"]] = None, + keyword: Optional[List["_models.CodeableConcept"]] = None, + location: Optional[List["_models.CodeableConcept"]] = None, + description: Optional[str] = None, + enrollment: Optional[List["_models.Reference"]] = None, + period: Optional["_models.Period"] = None, + sponsor: Optional["_models.Reference"] = None, + principal_investigator: Optional["_models.Reference"] = None, + site: Optional[List["_models.Reference"]] = None, + reason_stopped: Optional["_models.CodeableConcept"] = None, + note: Optional[List["_models.Annotation"]] = None, + arm: Optional[List["_models.ResearchStudyArm"]] = None, + objective: Optional[List["_models.ResearchStudyObjective"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.resource_type: Literal["ResearchStudy"] = "ResearchStudy" + + +class ResearchStudyArm(_model_base.Model): + """ResearchStudyArm. + + All required parameters must be populated in order to send to server. + + :ivar name: Label for study arm. Required. + :vartype name: str + :ivar type: Categorization of study arm. + :vartype type: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar description: Short explanation of study path. + :vartype description: str + """ + + name: str = rest_field() + """Label for study arm. Required.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Categorization of study arm.""" + description: Optional[str] = rest_field() + """Short explanation of study path.""" + + @overload + def __init__( + self, + *, + name: str, + type: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResearchStudyObjective(_model_base.Model): + """ResearchStudyObjective. + + All required parameters must be populated in order to send to server. + + :ivar name: Label for the objective. Required. + :vartype name: str + :ivar type: primary | secondary | exploratory. + :vartype type: ~azure.healthinsights.patienttimeline.models.CodeableConcept + """ + + name: str = rest_field() + """Label for the objective. Required.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """primary | secondary | exploratory.""" + + @overload + def __init__( + self, + *, + name: str, + type: Optional["_models.CodeableConcept"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SampledData(Element): + """A series of measurements taken by a device + Based on `FHIR SampledData `_. + + All required parameters must be populated in order to send to server. + + :ivar origin: Zero value and units. Required. + :vartype origin: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar period: Number of milliseconds between samples. Required. + :vartype period: float + :ivar factor: Multiply data by this before adding to origin. + :vartype factor: float + :ivar lower_limit: Lower limit of detection. + :vartype lower_limit: float + :ivar upper_limit: Upper limit of detection. + :vartype upper_limit: float + :ivar dimensions: Number of sample points at each time point. Required. + :vartype dimensions: int + :ivar data: Decimal values with spaces, or "E" | "U" | "L". + :vartype data: str + """ + + origin: "_models.Quantity" = rest_field() + """Zero value and units. Required.""" + period: float = rest_field() + """Number of milliseconds between samples. Required.""" + factor: Optional[float] = rest_field() + """Multiply data by this before adding to origin.""" + lower_limit: Optional[float] = rest_field(name="lowerLimit") + """Lower limit of detection.""" + upper_limit: Optional[float] = rest_field(name="upperLimit") + """Upper limit of detection.""" + dimensions: int = rest_field() + """Number of sample points at each time point. Required.""" + data: Optional[str] = rest_field() + """Decimal values with spaces, or \"E\" | \"U\" | \"L\".""" + + @overload + def __init__( + self, + *, + origin: "_models.Quantity", + period: float, + dimensions: int, + factor: Optional[float] = None, + lower_limit: Optional[float] = None, + upper_limit: Optional[float] = None, + data: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TimePeriod(_model_base.Model): + """A duration of time during which an event is happening. + + :ivar start: Starting time with inclusive boundary. + :vartype start: ~datetime.datetime + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: ~datetime.datetime + """ + + start: Optional[datetime.datetime] = rest_field(format="rfc3339") + """Starting time with inclusive boundary.""" + end: Optional[datetime.datetime] = rest_field(format="rfc3339") + """End time with inclusive boundary, if not ongoing.""" + + @overload + def __init__( + self, + *, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_patch.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/py.typed b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/py.typed new file mode 100644 index 0000000000000..e5aff4f83af86 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/dev_requirements.txt b/sdk/healthinsights/azure-healthinsights-patienttimeline/dev_requirements.txt new file mode 100644 index 0000000000000..ff12ab35dd010 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/dev_requirements.txt @@ -0,0 +1,4 @@ +-e ../../../tools/azure-devtools +-e ../../../tools/azure-sdk-tools +../../core/azure-core +aiohttp \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/sdk_packaging.toml b/sdk/healthinsights/azure-healthinsights-patienttimeline/sdk_packaging.toml new file mode 100644 index 0000000000000..e7687fdae93bc --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/sdk_packaging.toml @@ -0,0 +1,2 @@ +[packaging] +auto_update = false \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/setup.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/setup.py new file mode 100644 index 0000000000000..6986ece157ef6 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/setup.py @@ -0,0 +1,70 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# coding: utf-8 + +import os +import re +from setuptools import setup, find_packages + + +PACKAGE_NAME = "azure-healthinsights-patienttimeline" +PACKAGE_PPRINT_NAME = "Azure Health Insights - Patient Timeline" + +# a-b-c => a/b/c +package_folder_path = PACKAGE_NAME.replace("-", "/") + +# Version extraction inspired from 'requests' +with open(os.path.join(package_folder_path, "_version.py"), "r") as fd: + version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) + +if not version: + raise RuntimeError("Cannot find version information") + + +setup( + name=PACKAGE_NAME, + version=version, + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), + long_description=open("README.md", "r").read(), + long_description_content_type="text/markdown", + license="MIT License", + author="Microsoft Corporation", + author_email="azpysdkhelp@microsoft.com", + url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", + keywords="azure, azure sdk", + classifiers=[ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "License :: OSI Approved :: MIT License", + ], + zip_safe=False, + packages=find_packages( + exclude=[ + "tests", + # Exclude packages that will be covered by PEP420 or nspkg + "azure", + "azure.healthinsights", + ] + ), + include_package_data=True, + package_data={ + "azure.healthinsights.patienttimeline": ["py.typed"], + }, + install_requires=[ + "isodate<1.0.0,>=0.6.1", + "azure-core<2.0.0,>=1.29.5", + ], + python_requires=">=3.8", +) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/tsp-location.yaml b/sdk/healthinsights/azure-healthinsights-patienttimeline/tsp-location.yaml new file mode 100644 index 0000000000000..d79a8f045b07e --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/tsp-location.yaml @@ -0,0 +1,7 @@ +commit: f3dcae0fb8ccf9267fa0c8eb32f52125c58cd0fd +additionalDirectories: +- specification/ai/HealthInsights/HealthInsights.Common/ +- specification/ai/HealthInsights/HealthInsights.OpenAPI/ +directory: specification/ai/HealthInsights/HealthInsights.PatientTimeline +repo: Azure/azure-rest-api-specs + diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/CHANGELOG.md b/sdk/healthinsights/azure-healthinsights-radiologyinsights/CHANGELOG.md new file mode 100644 index 0000000000000..628743d283a92 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/CHANGELOG.md @@ -0,0 +1,5 @@ +# Release History + +## 1.0.0b1 (1970-01-01) + +- Initial version diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/LICENSE b/sdk/healthinsights/azure-healthinsights-radiologyinsights/LICENSE new file mode 100644 index 0000000000000..63447fd8bbbf7 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/MANIFEST.in b/sdk/healthinsights/azure-healthinsights-radiologyinsights/MANIFEST.in new file mode 100644 index 0000000000000..d2fd55d2d2adf --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/MANIFEST.in @@ -0,0 +1,7 @@ +include *.md +include LICENSE +include azure/healthinsights/radiologyinsights/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py +include azure/healthinsights/__init__.py \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/README.md b/sdk/healthinsights/azure-healthinsights-radiologyinsights/README.md new file mode 100644 index 0000000000000..ffada5b551e29 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/README.md @@ -0,0 +1,45 @@ + + +# Azure Health Insights - Radiology Insights client library for Python + + +## Getting started + +### Installating the package + +```bash +python -m pip install azure-healthinsights-radiologyinsights +``` + +#### Prequisites + +- Python 3.8 or later is required to use this package. +- You need an [Azure subscription][azure_sub] to use this package. +- An existing Azure Health Insights - Radiology Insights instance. + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, +see the Code of Conduct FAQ or contact opencode@microsoft.com with any +additional questions or comments. + + +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token +[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials +[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential +[pip]: https://pypi.org/project/pip/ +[azure_sub]: https://azure.microsoft.com/free/ + diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/_meta.json b/sdk/healthinsights/azure-healthinsights-radiologyinsights/_meta.json new file mode 100644 index 0000000000000..f0a8183498a88 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "f3dcae0fb8ccf9267fa0c8eb32f52125c58cd0fd", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/ai/HealthInsights/HealthInsights.RadiologyInsights", + "@azure-tools/typespec-python": "0.18.3" +} \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/__init__.py new file mode 100644 index 0000000000000..d55ccad1f573f --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/__init__.py new file mode 100644 index 0000000000000..d55ccad1f573f --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/__init__.py new file mode 100644 index 0000000000000..280758827c610 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/__init__.py @@ -0,0 +1,26 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import RadiologyInsightsClient +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "RadiologyInsightsClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_client.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_client.py new file mode 100644 index 0000000000000..bc35db4ec225c --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_client.py @@ -0,0 +1,100 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any + +from azure.core import PipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import RadiologyInsightsClientConfiguration +from ._operations import RadiologyInsightsClientOperationsMixin +from ._serialization import Deserializer, Serializer + + +class RadiologyInsightsClient( + RadiologyInsightsClientOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword + """RadiologyInsightsClient. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + _endpoint = "{endpoint}/health-insights" + self._config = RadiologyInsightsClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> "RadiologyInsightsClient": + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_configuration.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_configuration.py new file mode 100644 index 0000000000000..25010ae540657 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_configuration.py @@ -0,0 +1,62 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +from ._version import VERSION + + +class RadiologyInsightsClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for RadiologyInsightsClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + kwargs.setdefault("sdk_moniker", "healthinsights-radiologyinsights/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AzureKeyCredentialPolicy( + self.credential, "Ocp-Apim-Subscription-Key", **kwargs + ) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_model_base.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_model_base.py new file mode 100644 index 0000000000000..585ccb0e0f90a --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_model_base.py @@ -0,0 +1,828 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except +# pyright: reportGeneralTypeIssues=false + +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import copy +import typing +import email +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] # pylint: disable=protected-access + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): # pylint: disable=unsubscriptable-object + def __init__(self, data: typing.Dict[str, typing.Any]) -> None: + self._data = copy.deepcopy(data) + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + try: + return self[key] + except KeyError: + return default + + @typing.overload # type: ignore + def pop(self, key: str) -> typing.Any: # pylint: disable=no-member + ... + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: + ... + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> typing.Tuple[str, typing.Any]: + return self._data.popitem() + + def clear(self) -> None: + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: + self._data.update(*args, **kwargs) + + @typing.overload # type: ignore + def setdefault(self, key: str) -> typing.Any: + ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: + ... + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field( + attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str +) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + return _deserialize(rf._type, value) if (rf and rf._is_model) else _serialize(value, rf._format if rf else None) + + +class Model(_MyMutableMapping): + _is_model = True + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> "Model": # pylint: disable=unused-argument + # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' + mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order + attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") # pylint: disable=no-member + for k, v in mro_class.__annotations__.items() # pylint: disable=no-member + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items()) + + return super().__new__(cls) # pylint: disable=no-value-for-parameter + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): # pylint: disable=no-member + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: + for v in cls.__dict__.values(): + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access + return v._rest_name # pylint: disable=protected-access + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): # pylint: disable=no-member + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pylint: disable=no-member + if mapped_cls == cls: + return cls(data) + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore[reportUnboundVariable] + continue + result[k] = Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return [Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v] + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation or annotation in [int, float]: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + return functools.partial(_deserialize_model, annotation) + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf + ) + + def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + except AttributeError: + pass + + if getattr(annotation, "__origin__", None) is typing.Union: + deserializers = [_get_deserialize_callable_from_annotation(arg, module, rf) for arg in annotation.__args__] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) + + try: + if annotation._name == "Dict": + value_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[1], module, rf) + + def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + obj: typing.Dict[typing.Any, typing.Any], + ): + if obj is None: + return obj + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + return functools.partial( + _deserialize_dict, + value_deserializer, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: + if len(annotation.__args__) > 1: + + def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, + ): + if obj is None: + return obj + return type(obj)( + _deserialize(deserializer, entry, module) + for entry, deserializer in zip(obj, entry_deserializers) + ) + + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) for dt in annotation.__args__ + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers) + deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) + + def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + obj, + ): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + return functools.partial(_deserialize_sequence, deserializer) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): + try: + if value is None or isinstance(value, _Null): + return None + if deserializer is None: + return value + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, +) -> typing.Any: + return _RestField(name=name, type=type, visibility=visibility, default=default, format=format) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/__init__.py new file mode 100644 index 0000000000000..24be3b0c64fce --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/__init__.py @@ -0,0 +1,19 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import RadiologyInsightsClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "RadiologyInsightsClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_operations.py new file mode 100644 index 0000000000000..b289a88290220 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_operations.py @@ -0,0 +1,2255 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import datetime +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload +import uuid + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.polling import LROPoller, NoPolling, PollingMethod +from azure.core.polling.base_polling import LROBasePolling +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._model_base import SdkJSONEncoder, _deserialize +from .._serialization import Serializer +from .._vendor import RadiologyInsightsClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_radiology_insights_infer_radiology_insights_request( # pylint: disable=name-too-long + **kwargs: Any, +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/radiology-insights/jobs" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if "Repeatability-Request-ID" not in _headers: + _headers["Repeatability-Request-ID"] = str(uuid.uuid4()) + if "Repeatability-First-Sent" not in _headers: + _headers["Repeatability-First-Sent"] = _SERIALIZER.serialize_data( + datetime.datetime.now(datetime.timezone.utc), "rfc-1123" + ) + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +class RadiologyInsightsClientOperationsMixin(RadiologyInsightsClientMixinABC): + def _infer_radiology_insights_initial( + self, body: Union[_models.RadiologyInsightsData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[JSON] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_radiology_insights_infer_radiology_insights_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(JSON, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_infer_radiology_insights( + self, body: _models.RadiologyInsightsData, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.RadiologyInsightsInferenceResult]: + # pylint: disable=line-too-long + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Required. + :type body: ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsData + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceOptions": { + "findingOptions": { + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide the sentence that contains the first token + of the finding's clinical indicator (i.e. the medical problem), if + there is one. This sentence is provided as an extension with url + 'ci_sentence', next to the token evidence. Default is false. + }, + "followupRecommendationOptions": { + "includeRecommendationsInReferences": bool, # + Optional. Include/Exclude follow-up recommendations in references to + a guideline or article. Default is false. + "includeRecommendationsWithNoSpecifiedModality": + bool, # Optional. Include/Exclude follow-up recommendations without + a specific radiology procedure. Default is false. + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide one or more sentences as evidence for the + recommendation, next to the token evidence. The start and end + positions of these sentences will be put in an extension with url + 'modality_sentences'. Default is false. + } + }, + "inferenceTypes": [ + "str" # Optional. This is a list of inference types to be + inferred for the current request. It could be used if only part of the + Radiology Insights inferences are required. If this list is omitted or + empty, the model will return all the inference types. + ], + "locale": "str", # Optional. Local for the model to use. If not + specified, the model will use the default locale. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + + @overload + def begin_infer_radiology_insights( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.RadiologyInsightsInferenceResult]: + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + + @overload + def begin_infer_radiology_insights( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.RadiologyInsightsInferenceResult]: + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + + @distributed_trace + def begin_infer_radiology_insights( + self, body: Union[_models.RadiologyInsightsData, JSON, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.RadiologyInsightsInferenceResult]: + # pylint: disable=line-too-long + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Is one of the following types: RadiologyInsightsData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsData or JSON or + IO[bytes] + :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default + value is None. + :paramtype content_type: str + :return: An instance of LROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceOptions": { + "findingOptions": { + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide the sentence that contains the first token + of the finding's clinical indicator (i.e. the medical problem), if + there is one. This sentence is provided as an extension with url + 'ci_sentence', next to the token evidence. Default is false. + }, + "followupRecommendationOptions": { + "includeRecommendationsInReferences": bool, # + Optional. Include/Exclude follow-up recommendations in references to + a guideline or article. Default is false. + "includeRecommendationsWithNoSpecifiedModality": + bool, # Optional. Include/Exclude follow-up recommendations without + a specific radiology procedure. Default is false. + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide one or more sentences as evidence for the + recommendation, next to the token evidence. The start and end + positions of these sentences will be put in an extension with url + 'modality_sentences'. Default is false. + } + }, + "inferenceTypes": [ + "str" # Optional. This is a list of inference types to be + inferred for the current request. It could be used if only part of the + Radiology Insights inferences are required. If this list is omitted or + empty, the model will return all the inference types. + ], + "locale": "str", # Optional. Local for the model to use. If not + specified, the model will use the default locale. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.RadiologyInsightsInferenceResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._infer_radiology_insights_initial( + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response_headers = {} + response = pipeline_response.http_response + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.RadiologyInsightsInferenceResult, response.json().get("result")) + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + return deserialized + + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method: PollingMethod = cast( + PollingMethod, LROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs) + ) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.RadiologyInsightsInferenceResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.RadiologyInsightsInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_patch.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_patch.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_serialization.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_serialization.py new file mode 100644 index 0000000000000..baa661cb82d24 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_serialization.py @@ -0,0 +1,2005 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the ""Software""), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. +# +# -------------------------------------------------------------------------- + +# pylint: skip-file +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Dict, + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + TypeVar, + MutableMapping, + Type, + List, + Mapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +ModelType = TypeVar("ModelType", bound="Model") +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +try: + basestring # type: ignore + unicode_str = unicode # type: ignore +except NameError: + basestring = str + unicode_str = str + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + + +class UTC(datetime.tzinfo): + """Time Zone info for handling UTC""" + + def utcoffset(self, dt): + """UTF offset for UTC is 0.""" + return datetime.timedelta(0) + + def tzname(self, dt): + """Timestamp representation.""" + return "Z" + + def dst(self, dt): + """No daylight saving for UTC.""" + return datetime.timedelta(hours=1) + + +try: + from datetime import timezone as _FixedOffset # type: ignore +except ImportError: # Python 2.7 + + class _FixedOffset(datetime.tzinfo): # type: ignore + """Fixed offset in minutes east from UTC. + Copy/pasted from Python doc + :param datetime.timedelta offset: offset in timedelta format + """ + + def __init__(self, offset): + self.__offset = offset + + def utcoffset(self, dt): + return self.__offset + + def tzname(self, dt): + return str(self.__offset.total_seconds() / 3600) + + def __repr__(self): + return "".format(self.tzname(None)) + + def dst(self, dt): + return datetime.timedelta(0) + + def __getinitargs__(self): + return (self.__offset,) + + +try: + from datetime import timezone + + TZ_UTC = timezone.utc +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[Dict[str, Any]] = {} + for k in kwargs: + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node.""" + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls: Type[ModelType], + data: Any, + key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> ModelType: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result.update(objects[valuetype]._flatten_subtype(key, objects)) + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + Remove the polymorphic key from the initial data. + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + """ + return key.replace("\\.", ".") + + +class Serializer(object): + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize(self, target_obj, data_type=None, **kwargs): + """Serialize data into a string according to type. + + :param target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises: SerializationError if serialization fails. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() + try: + attributes = target_obj._attribute_map + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized.update(target_obj.additional_properties) + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = unicode_str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + else: + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises: SerializationError if serialization fails. + :raises: ValueError if data is None + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :param bool required: Whether it's essential that the data not be + empty or None + :raises: AttributeError if required data is None. + :raises: ValueError if data is None + :raises: SerializationError if serialization fails. + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + elif data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, data.__class__) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + else: + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param data: Object to be serialized. + :param str data_type: Type of object in the iterable. + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param data: Object to be serialized. + :rtype: str + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + else: + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list attr: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param bool required: Whether the objects in the iterable must + not be None or empty. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. + :rtype: list, str + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :param bool required: Whether the objects in the dictionary must + not be None or empty. + :rtype: dict + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is unicode_str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + elif obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) + + @staticmethod + def serialize_bytearray(attr, **kwargs): + """Serialize bytearray into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): + """Serialize str into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): + """Serialize Decimal object to float. + + :param attr: Object to be serialized. + :rtype: float + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): + """Serialize long (Py2) or int (Py3). + + :param attr: Object to be serialized. + :rtype: int/long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: TypeError if format invalid. + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError: + raise TypeError("RFC1123 object must be valid Datetime object.") + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: SerializationError if format invalid. + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises: SerializationError if format invalid + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError: + raise TypeError("Unix time object must be valid Datetime object.") + + +def rest_key_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(List[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key.""" + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + else: + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + else: # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer(object): + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, basestring): + return self.deserialize_data(data, response) + elif isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None: + return data + try: + attributes = response._attribute_map # type: ignore + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + else: + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + """ + if target is None: + return None, None + + if isinstance(target, basestring): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + """ + try: + return self(target_obj, data, content_type=content_type) + except: + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param raw_data: Data to be processed. + :param content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (basestring, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param response: The response model class. + :param d_attrs: The deserialized response attributes. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [k for k, v in response._validation.items() if v.get("readonly")] + const = [k for k, v in response._validation.items() if v.get("constant")] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) + + def deserialize_data(self, data, data_type): + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in ["object", "[]", r"{}"] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + else: + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :rtype: dict + :raises: TypeError if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, basestring): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + else: + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :rtype: str, int, float or bool + :raises: TypeError if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + else: + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + elif isinstance(attr, basestring): + if attr.lower() in ["true", "1"]: + return True + elif attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + else: + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :rtype: Decimal + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :rtype: long or int + :raises: ValueError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :rtype: TimeDelta + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + else: + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :rtype: Date + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :rtype: Datetime + :raises: DeserializationError if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + else: + return date_obj diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_types.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_types.py new file mode 100644 index 0000000000000..52104a479bf79 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_types.py @@ -0,0 +1,12 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Literal, Union + +RepeatabilityResult = Union[Literal["accepted"], Literal["rejected"]] diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_vendor.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_vendor.py new file mode 100644 index 0000000000000..cea1829f79e31 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_vendor.py @@ -0,0 +1,26 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import RadiologyInsightsClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import PipelineClient + + from ._serialization import Deserializer, Serializer + + +class RadiologyInsightsClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "PipelineClient" + _config: RadiologyInsightsClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_version.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_version.py new file mode 100644 index 0000000000000..be71c81bd2821 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/__init__.py new file mode 100644 index 0000000000000..3a05b0feea6f6 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/__init__.py @@ -0,0 +1,23 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import RadiologyInsightsClient + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "RadiologyInsightsClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_client.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_client.py new file mode 100644 index 0000000000000..20e5e0ec1799c --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_client.py @@ -0,0 +1,102 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Awaitable + +from azure.core import AsyncPipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._serialization import Deserializer, Serializer +from ._configuration import RadiologyInsightsClientConfiguration +from ._operations import RadiologyInsightsClientOperationsMixin + + +class RadiologyInsightsClient( + RadiologyInsightsClientOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword + """RadiologyInsightsClient. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + _endpoint = "{endpoint}/health-insights" + self._config = RadiologyInsightsClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> "RadiologyInsightsClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_configuration.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_configuration.py new file mode 100644 index 0000000000000..928142f56c335 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_configuration.py @@ -0,0 +1,62 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +from .._version import VERSION + + +class RadiologyInsightsClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for RadiologyInsightsClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + kwargs.setdefault("sdk_moniker", "healthinsights-radiologyinsights/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AzureKeyCredentialPolicy( + self.credential, "Ocp-Apim-Subscription-Key", **kwargs + ) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/__init__.py new file mode 100644 index 0000000000000..24be3b0c64fce --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/__init__.py @@ -0,0 +1,19 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import RadiologyInsightsClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "RadiologyInsightsClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_operations.py new file mode 100644 index 0000000000000..4f8d6ab20d79f --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_operations.py @@ -0,0 +1,2221 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod +from azure.core.polling.async_base_polling import AsyncLROBasePolling +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models +from ..._model_base import SdkJSONEncoder, _deserialize +from ..._operations._operations import build_radiology_insights_infer_radiology_insights_request +from .._vendor import RadiologyInsightsClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + + +class RadiologyInsightsClientOperationsMixin(RadiologyInsightsClientMixinABC): + async def _infer_radiology_insights_initial( + self, body: Union[_models.RadiologyInsightsData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[JSON] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_radiology_insights_infer_radiology_insights_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(JSON, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_infer_radiology_insights( + self, body: _models.RadiologyInsightsData, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.RadiologyInsightsInferenceResult]: + # pylint: disable=line-too-long + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Required. + :type body: ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsData + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceOptions": { + "findingOptions": { + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide the sentence that contains the first token + of the finding's clinical indicator (i.e. the medical problem), if + there is one. This sentence is provided as an extension with url + 'ci_sentence', next to the token evidence. Default is false. + }, + "followupRecommendationOptions": { + "includeRecommendationsInReferences": bool, # + Optional. Include/Exclude follow-up recommendations in references to + a guideline or article. Default is false. + "includeRecommendationsWithNoSpecifiedModality": + bool, # Optional. Include/Exclude follow-up recommendations without + a specific radiology procedure. Default is false. + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide one or more sentences as evidence for the + recommendation, next to the token evidence. The start and end + positions of these sentences will be put in an extension with url + 'modality_sentences'. Default is false. + } + }, + "inferenceTypes": [ + "str" # Optional. This is a list of inference types to be + inferred for the current request. It could be used if only part of the + Radiology Insights inferences are required. If this list is omitted or + empty, the model will return all the inference types. + ], + "locale": "str", # Optional. Local for the model to use. If not + specified, the model will use the default locale. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + + @overload + async def begin_infer_radiology_insights( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.RadiologyInsightsInferenceResult]: + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + + @overload + async def begin_infer_radiology_insights( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.RadiologyInsightsInferenceResult]: + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + + @distributed_trace_async + async def begin_infer_radiology_insights( + self, body: Union[_models.RadiologyInsightsData, JSON, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.RadiologyInsightsInferenceResult]: + # pylint: disable=line-too-long + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Is one of the following types: RadiologyInsightsData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsData or JSON or + IO[bytes] + :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default + value is None. + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceOptions": { + "findingOptions": { + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide the sentence that contains the first token + of the finding's clinical indicator (i.e. the medical problem), if + there is one. This sentence is provided as an extension with url + 'ci_sentence', next to the token evidence. Default is false. + }, + "followupRecommendationOptions": { + "includeRecommendationsInReferences": bool, # + Optional. Include/Exclude follow-up recommendations in references to + a guideline or article. Default is false. + "includeRecommendationsWithNoSpecifiedModality": + bool, # Optional. Include/Exclude follow-up recommendations without + a specific radiology procedure. Default is false. + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide one or more sentences as evidence for the + recommendation, next to the token evidence. The start and end + positions of these sentences will be put in an extension with url + 'modality_sentences'. Default is false. + } + }, + "inferenceTypes": [ + "str" # Optional. This is a list of inference types to be + inferred for the current request. It could be used if only part of the + Radiology Insights inferences are required. If this list is omitted or + empty, the model will return all the inference types. + ], + "locale": "str", # Optional. Local for the model to use. If not + specified, the model will use the default locale. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.RadiologyInsightsInferenceResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._infer_radiology_insights_initial( + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response_headers = {} + response = pipeline_response.http_response + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.RadiologyInsightsInferenceResult, response.json().get("result")) + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + return deserialized + + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method: AsyncPollingMethod = cast( + AsyncPollingMethod, + AsyncLROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs), + ) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.RadiologyInsightsInferenceResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.RadiologyInsightsInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_patch.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_patch.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_vendor.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_vendor.py new file mode 100644 index 0000000000000..e2c3b938b89d3 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_vendor.py @@ -0,0 +1,26 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import RadiologyInsightsClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import AsyncPipelineClient + + from .._serialization import Deserializer, Serializer + + +class RadiologyInsightsClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "AsyncPipelineClient" + _config: RadiologyInsightsClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/__init__.py new file mode 100644 index 0000000000000..9e0bf9ad1397f --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/__init__.py @@ -0,0 +1,173 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._models import AgeMismatchInference +from ._models import Annotation +from ._models import CodeableConcept +from ._models import Coding +from ._models import CompleteOrderDiscrepancyInference +from ._models import Condition +from ._models import ConditionStage +from ._models import ContactDetail +from ._models import ContactPoint +from ._models import CriticalResult +from ._models import CriticalResultInference +from ._models import DocumentAdministrativeMetadata +from ._models import DocumentAuthor +from ._models import DocumentContent +from ._models import DomainResource +from ._models import Element +from ._models import Encounter +from ._models import Error +from ._models import Extension +from ._models import FindingInference +from ._models import FindingOptions +from ._models import FollowupCommunicationInference +from ._models import FollowupRecommendationInference +from ._models import FollowupRecommendationOptions +from ._models import GenericProcedureRecommendation +from ._models import HealthInsightsOperationStatus +from ._models import Identifier +from ._models import ImagingProcedure +from ._models import ImagingProcedureRecommendation +from ._models import InnerError +from ._models import LateralityDiscrepancyInference +from ._models import LimitedOrderDiscrepancyInference +from ._models import Meta +from ._models import Narrative +from ._models import Observation +from ._models import ObservationComponent +from ._models import ObservationReferenceRange +from ._models import OrderedProcedure +from ._models import PatientDetails +from ._models import PatientDocument +from ._models import PatientRecord +from ._models import Period +from ._models import ProcedureRecommendation +from ._models import Quantity +from ._models import RadiologyCodeWithTypes +from ._models import RadiologyInsightsData +from ._models import RadiologyInsightsInference +from ._models import RadiologyInsightsInferenceOptions +from ._models import RadiologyInsightsInferenceResult +from ._models import RadiologyInsightsModelConfiguration +from ._models import RadiologyInsightsPatientResult +from ._models import RadiologyProcedureInference +from ._models import Range +from ._models import Ratio +from ._models import RecommendationFinding +from ._models import Reference +from ._models import ResearchStudy +from ._models import ResearchStudyArm +from ._models import ResearchStudyObjective +from ._models import Resource +from ._models import SampledData +from ._models import SexMismatchInference +from ._models import TimePeriod + +from ._enums import ClinicalDocumentType +from ._enums import ContactPointSystem +from ._enums import ContactPointUse +from ._enums import DocumentContentSourceType +from ._enums import DocumentType +from ._enums import EncounterClass +from ._enums import JobStatus +from ._enums import LateralityDiscrepancyType +from ._enums import MedicalProfessionalType +from ._enums import ObservationStatusCodeType +from ._enums import PatientSex +from ._enums import RadiologyInsightsInferenceType +from ._enums import RecommendationFindingStatusType +from ._enums import ResearchStudyStatusCodeType +from ._enums import SpecialtyType +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "AgeMismatchInference", + "Annotation", + "CodeableConcept", + "Coding", + "CompleteOrderDiscrepancyInference", + "Condition", + "ConditionStage", + "ContactDetail", + "ContactPoint", + "CriticalResult", + "CriticalResultInference", + "DocumentAdministrativeMetadata", + "DocumentAuthor", + "DocumentContent", + "DomainResource", + "Element", + "Encounter", + "Error", + "Extension", + "FindingInference", + "FindingOptions", + "FollowupCommunicationInference", + "FollowupRecommendationInference", + "FollowupRecommendationOptions", + "GenericProcedureRecommendation", + "HealthInsightsOperationStatus", + "Identifier", + "ImagingProcedure", + "ImagingProcedureRecommendation", + "InnerError", + "LateralityDiscrepancyInference", + "LimitedOrderDiscrepancyInference", + "Meta", + "Narrative", + "Observation", + "ObservationComponent", + "ObservationReferenceRange", + "OrderedProcedure", + "PatientDetails", + "PatientDocument", + "PatientRecord", + "Period", + "ProcedureRecommendation", + "Quantity", + "RadiologyCodeWithTypes", + "RadiologyInsightsData", + "RadiologyInsightsInference", + "RadiologyInsightsInferenceOptions", + "RadiologyInsightsInferenceResult", + "RadiologyInsightsModelConfiguration", + "RadiologyInsightsPatientResult", + "RadiologyProcedureInference", + "Range", + "Ratio", + "RecommendationFinding", + "Reference", + "ResearchStudy", + "ResearchStudyArm", + "ResearchStudyObjective", + "Resource", + "SampledData", + "SexMismatchInference", + "TimePeriod", + "ClinicalDocumentType", + "ContactPointSystem", + "ContactPointUse", + "DocumentContentSourceType", + "DocumentType", + "EncounterClass", + "JobStatus", + "LateralityDiscrepancyType", + "MedicalProfessionalType", + "ObservationStatusCodeType", + "PatientSex", + "RadiologyInsightsInferenceType", + "RecommendationFindingStatusType", + "ResearchStudyStatusCodeType", + "SpecialtyType", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_enums.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_enums.py new file mode 100644 index 0000000000000..b0d874d8dc4e1 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_enums.py @@ -0,0 +1,265 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class ClinicalDocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the clinical document.""" + + CONSULTATION = "consultation" + DISCHARGE_SUMMARY = "dischargeSummary" + HISTORY_AND_PHYSICAL = "historyAndPhysical" + RADIOLOGY_REPORT = "radiologyReport" + PROCEDURE = "procedure" + PROGRESS = "progress" + LABORATORY = "laboratory" + PATHOLOGY_REPORT = "pathologyReport" + + +class ContactPointSystem(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Contact Point System + see https://www.hl7.org/fhir/R4/valueset-contact-point-system.html. + """ + + PHONE = "phone" + """Phone""" + FAX = "fax" + """Fax""" + EMAIL = "email" + """Email""" + PAGER = "pager" + """Pager""" + URL = "url" + """Url""" + SMS = "sms" + """Sms""" + OTHER = "other" + """Other""" + + +class ContactPointUse(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Contact Point Use + See: http://hl7.org/fhir/ValueSet/contact-point-use. + """ + + HOME = "home" + """Home""" + WORK = "work" + """Work""" + TEMP = "temp" + """Temp""" + OLD = "old" + """Old""" + MOBILE = "mobile" + """Mobile""" + + +class DocumentContentSourceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. + """ + + INLINE = "inline" + """The content is given as a string (for instance, text).""" + REFERENCE = "reference" + """The content is given as a URI.""" + + +class DocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON + document). + """ + + NOTE = "note" + FHIR_BUNDLE = "fhirBundle" + DICOM = "dicom" + GENOMIC_SEQUENCING = "genomicSequencing" + + +class EncounterClass(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR + value set--http://....). + """ + + IN_PATIENT = "inpatient" + """A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned + to a location where patients generally stay at least overnight and provided with room, board, + and continuous nursing service.""" + AMBULATORY = "ambulatory" + """The term ambulatory usually implies that the patient has come to the location and is not + assigned to a bed. Sometimes referred to as an outpatient encounter.""" + OBSERVATION = "observation" + """An encounter where the patient usually will start in different encounter, such as one in the + emergency department but then transition to this type of encounter because they require a + significant period of treatment and monitoring to determine whether or not their condition + warrants an inpatient admission or discharge.""" + EMERGENCY = "emergency" + """A patient encounter that takes place at a dedicated healthcare service delivery location where + the patient receives immediate evaluation and treatment, provided until the patient can be + discharged or responsibility for the patient's care is transferred elsewhere (for example, the + patient could be admitted as an inpatient or transferred to another facility.""" + VIRTUAL = "virtual" + """A patient encounter where the patient is not physically present for the encounter, such as in a + telehealth encounter, phone call, or electronic communication.""" + HEALTH_HOME = "healthHome" + """Healthcare encounter that takes place in the residence of the patient or a designee""" + + +class JobStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The status of the processing job.""" + + NOT_STARTED = "notStarted" + RUNNING = "running" + SUCCEEDED = "succeeded" + FAILED = "failed" + CANCELED = "canceled" + + +class LateralityDiscrepancyType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Laterality discrepancy type.""" + + ORDER_LATERALITY_MISMATCH = "orderLateralityMismatch" + """Mismatch between order and text""" + TEXT_LATERALITY_CONTRADICTION = "textLateralityContradiction" + """Contradiction in text""" + TEXT_LATERALITY_MISSING = "textLateralityMissing" + """Missing laterality in text""" + + +class MedicalProfessionalType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Medical Professional Type.""" + + UNKNOWN = "unknown" + """Unknown medical professional type""" + DOCTOR = "doctor" + """Doctor medical professional type""" + NURSE = "nurse" + """Nurse medical professional type""" + MIDWIFE = "midwife" + """Technician medical professional type""" + PHYSICIAN_ASSISTANT = "physicianAssistant" + """Technician medical professional type""" + + +class ObservationStatusCodeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Observation Status + Based on `FHIR ObservationStatus + `_. + """ + + REGISTERED = "registered" + """The existence of the observation is registered, but there is no result yet available.""" + PRELIMINARY = "preliminary" + """This is an initial or interim observation: data may be incomplete or unverified.""" + FINAL = "final" + """The observation is complete and verified by an authorized person.""" + AMENDED = "amended" + """Subsequent to being Final, the observation has been modified subsequent. This includes + updates/new information and corrections.""" + CORRECTED = "corrected" + """Subsequent to being Final, the observation has been modified to correct an error in the test + result.""" + CANCELLED = "cancelled" + """The observation is unavailable because the measurement was not started or not completed (also + sometimes called "aborted").""" + ENTERED_IN_ERROR = "entered-in-error" + """The observation has been withdrawn following previous final release.""" + UNKNOWN = "unknown" + """The observation status is unknown. Note that "unknown" is a value of last resort and every + attempt should be made to provide a meaningful value other than "unknown".""" + + +class PatientSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The patient's sex.""" + + FEMALE = "female" + MALE = "male" + UNSPECIFIED = "unspecified" + + +class RadiologyInsightsInferenceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """A Radiology Insights inference types.""" + + AGE_MISMATCH = "ageMismatch" + """Age mismatch inference type""" + LATERALITY_DISCREPANCY = "lateralityDiscrepancy" + """Laterality discrepancy inference type""" + SEX_MISMATCH = "sexMismatch" + """Sex mismatch inference type""" + COMPLETE_ORDER_DISCREPANCY = "completeOrderDiscrepancy" + """Complete order discrepancy inference type""" + LIMITED_ORDER_DISCREPANCY = "limitedOrderDiscrepancy" + """Limited order discrepancy inference type""" + FINDING = "finding" + """Finding inference type""" + CRITICAL_RESULT = "criticalResult" + """Critical finding inference type""" + FOLLOWUP_RECOMMENDATION = "followupRecommendation" + """Recommendation inference type""" + FOLLOWUP_COMMUNICATION = "followupCommunication" + """Followup Communication inference type""" + RADIOLOGY_PROCEDURE = "radiologyProcedure" + """Radiology Procedure inference type""" + + +class RecommendationFindingStatusType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Recommendation finding status.""" + + PRESENT = "present" + """Present finding status""" + DIFFERENTIAL = "differential" + """Differential finding status""" + RULE_OUT = "ruleOut" + """Rule out finding status""" + CONDITIONAL = "conditional" + """Conditional finding status""" + + +class ResearchStudyStatusCodeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """https://www.hl7.org/fhir/R4/codesystem-research-study-status.html.""" + + ACTIVE = "active" + """The study is open for accrual.""" + ADMINISTRATIVELY_COMPLETED = "administratively-completed" + """Study is completed prematurely and will not resume; patients are no longer examined nor + treated.""" + APPROVED = "approved" + """Protocol is approved by the review board.""" + CLOSED_TO_ACCRUAL = "closed-to-accrual" + """Study is closed for accrual; patients can be examined and treated.""" + CLOSED_TO_ACCRUAL_AND_INTERVENTION = "closed-to-accrual-and-intervention" + """The study is closed to accrual and intervention, i.e. the study is closed to enrollment, all + study subjects have completed treatment or intervention but are still being followed according + to the primary objective of the study.""" + COMPLETED = "completed" + """Study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study + subjects have completed treatment or intervention but are still being followed according to the + primary objective of the study.""" + DISAPPROVED = "disapproved" + """Protocol was disapproved by the review board.""" + IN_REVIEW = "in-review" + """Protocol is submitted to the review board for approval.""" + TEMPORARILY_CLOSED_TO_ACCRUAL = "temporarily-closed-to-accrual" + """The study is temporarily closed to accrual; a pause in accrual while study is reviewed, but is + expected to resume.""" + TEMPORARILY_CLOSED_TO_ACCRUAL_AND_INTERVENTION = "temporarily-closed-to-accrual-and-intervention" + """Study is temporarily closed for accrual; can be potentially resumed in the future""" + WITHDRAWN = "withdrawn" + """Protocol was withdrawn by the lead organization.""" + + +class SpecialtyType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the type of the Specialty.""" + + PATHOLOGY = "pathology" + """pathology""" + RADIOLOGY = "radiology" + """radiology""" diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_models.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_models.py new file mode 100644 index 0000000000000..7789b41f9ed34 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_models.py @@ -0,0 +1,3523 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +import datetime +from typing import Any, Dict, List, Literal, Mapping, Optional, TYPE_CHECKING, Union, overload + +from .. import _model_base +from .._model_base import rest_discriminator, rest_field +from ._enums import RadiologyInsightsInferenceType + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from .. import models as _models + + +class RadiologyInsightsInference(_model_base.Model): + """An inference made by the Radiology Insights model regarding a patient. + + + * AgeMismatch + * SexMismatch + * LateralityDiscrepancy + * CompleteOrderDiscrepancy + * LimitedOrderDiscrepancy + * Finding + * CriticalResult + * FollowupRecommendation + * RadiologyProcedure + * FollowupCommunication. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + AgeMismatchInference, CompleteOrderDiscrepancyInference, CriticalResultInference, + FindingInference, FollowupCommunicationInference, FollowupRecommendationInference, + LateralityDiscrepancyInference, LimitedOrderDiscrepancyInference, RadiologyProcedureInference, + SexMismatchInference + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Required. Known values are: "ageMismatch", "lateralityDiscrepancy", "sexMismatch", + "completeOrderDiscrepancy", "limitedOrderDiscrepancy", "finding", "criticalResult", + "followupRecommendation", "followupCommunication", and "radiologyProcedure". + :vartype kind: str or + ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceType + """ + + __mapping__: Dict[str, _model_base.Model] = {} + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + kind: Literal[None] = rest_discriminator(name="kind") + """Required. Known values are: \"ageMismatch\", \"lateralityDiscrepancy\", \"sexMismatch\", + \"completeOrderDiscrepancy\", \"limitedOrderDiscrepancy\", \"finding\", \"criticalResult\", + \"followupRecommendation\", \"followupCommunication\", and \"radiologyProcedure\".""" + + @overload + def __init__( + self, + *, + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal[None] = None + + +class AgeMismatchInference(RadiologyInsightsInference, discriminator="ageMismatch"): + """A notification for age mismatch is displayed when the age mentioned in a document for a + specific patient does not match the age specified in the patient information. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Age mismatch inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.AGE_MISMATCH + """ + + kind: Literal[RadiologyInsightsInferenceType.AGE_MISMATCH] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Age mismatch inference type""" + + @overload + def __init__( + self, + *, + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal[RadiologyInsightsInferenceType.AGE_MISMATCH] = RadiologyInsightsInferenceType.AGE_MISMATCH + + +class Element(_model_base.Model): + """The base definition for all elements contained inside a resource. + Based on `FHIR Element `_. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + """ + + id: Optional[str] = rest_field() + """Unique id for inter-element referencing.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Annotation(Element): + """A text note which also contains information about who made the statement and when + Based on `FHIR Annotation `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar author_string: Individual responsible for the annotation. + :vartype author_string: str + :ivar time: When the annotation was made. + :vartype time: str + :ivar text: The annotation - text content (as markdown). Required. + :vartype text: str + """ + + author_string: Optional[str] = rest_field(name="authorString") + """Individual responsible for the annotation.""" + time: Optional[str] = rest_field() + """When the annotation was made.""" + text: str = rest_field() + """The annotation - text content (as markdown). Required.""" + + @overload + def __init__( + self, + *, + text: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + author_string: Optional[str] = None, + time: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CodeableConcept(Element): + """Concept - reference to a terminology or just text + Based on `FHIR CodeableConcept `_. + + :ivar coding: Code defined by a terminology system. + :vartype coding: list[~azure.healthinsights.radiologyinsights.models.Coding] + :ivar text: Plain text representation of the concept. + :vartype text: str + """ + + coding: Optional[List["_models.Coding"]] = rest_field() + """Code defined by a terminology system.""" + text: Optional[str] = rest_field() + """Plain text representation of the concept.""" + + @overload + def __init__( + self, + *, + coding: Optional[List["_models.Coding"]] = None, + text: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Coding(Element): + """A Coding is a representation of a defined concept using a symbol from a defined "code system". + Based on `FHIR Coding `_. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar system: Identity of the terminology system. + :vartype system: str + :ivar version: Version of the system - if relevant. + :vartype version: str + :ivar code: Symbol in syntax defined by the system. + :vartype code: str + :ivar display: Representation defined by the system. + :vartype display: str + """ + + system: Optional[str] = rest_field() + """Identity of the terminology system.""" + version: Optional[str] = rest_field() + """Version of the system - if relevant.""" + code: Optional[str] = rest_field() + """Symbol in syntax defined by the system.""" + display: Optional[str] = rest_field() + """Representation defined by the system.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + system: Optional[str] = None, + version: Optional[str] = None, + code: Optional[str] = None, + display: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CompleteOrderDiscrepancyInference(RadiologyInsightsInference, discriminator="completeOrderDiscrepancy"): + """A complete order discrepancy is shown when one or more body parts and/or measurements that + should be in the document (because there is a complete order) are not present. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Complete order discrepancy inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.COMPLETE_ORDER_DISCREPANCY + :ivar order_type: Order type : CPT ultrasound complete code for abdomen, retroperitoneal, + pelvis or breast. Required. + :vartype order_type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar missing_body_parts: List of missing body parts required by a complete order : SNOMED CT + codes. + :vartype missing_body_parts: + list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar missing_body_part_measurements: List of missing body parts that require measurement by a + complete order : SNOMED CT codes. + :vartype missing_body_part_measurements: + list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + """ + + kind: Literal[RadiologyInsightsInferenceType.COMPLETE_ORDER_DISCREPANCY] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Complete order discrepancy inference type""" + order_type: "_models.CodeableConcept" = rest_field(name="orderType") + """Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast. + Required.""" + missing_body_parts: Optional[List["_models.CodeableConcept"]] = rest_field(name="missingBodyParts") + """List of missing body parts required by a complete order : SNOMED CT codes.""" + missing_body_part_measurements: Optional[List["_models.CodeableConcept"]] = rest_field( + name="missingBodyPartMeasurements" + ) + """List of missing body parts that require measurement by a complete order : SNOMED CT codes.""" + + @overload + def __init__( + self, + *, + order_type: "_models.CodeableConcept", + extension: Optional[List["_models.Extension"]] = None, + missing_body_parts: Optional[List["_models.CodeableConcept"]] = None, + missing_body_part_measurements: Optional[List["_models.CodeableConcept"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal[ + RadiologyInsightsInferenceType.COMPLETE_ORDER_DISCREPANCY + ] = RadiologyInsightsInferenceType.COMPLETE_ORDER_DISCREPANCY + + +class Resource(_model_base.Model): + """Resource is the ancestor of DomainResource from which most resources are derived. Bundle, + Parameters, and Binary extend Resource directly. + Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html. + + All required parameters must be populated in order to send to server. + + :ivar resource_type: The type of resource. Required. + :vartype resource_type: str + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.radiologyinsights.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + """ + + resource_type: str = rest_field(name="resourceType") + """The type of resource. Required.""" + id: Optional[str] = rest_field() + """Resource Id.""" + meta: Optional["_models.Meta"] = rest_field() + """Metadata about the resource.""" + implicit_rules: Optional[str] = rest_field(name="implicitRules") + """A set of rules under which this content was created.""" + language: Optional[str] = rest_field() + """Language of the resource content.""" + + @overload + def __init__( + self, + *, + resource_type: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DomainResource(Resource): + """A resource with narrative, extensions, and contained resources + Based on `FHIR DomainResource `_. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + Condition, ResearchStudy + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.radiologyinsights.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.radiologyinsights.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.radiologyinsights.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar resource_type: Required. Default value is None. + :vartype resource_type: str + """ + + __mapping__: Dict[str, _model_base.Model] = {} + text: Optional["_models.Narrative"] = rest_field() + """Text summary of the resource, for human interpretation.""" + contained: Optional[List["_models.Resource"]] = rest_field() + """Contained, inline Resources.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + modifier_extension: Optional[List["_models.Extension"]] = rest_field(name="modifierExtension") + """Extensions that cannot be ignored.""" + resource_type: Literal[None] = rest_discriminator(name="resourceType") + """Required. Default value is None.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.resource_type: Literal[None] = None + + +class Condition(DomainResource, discriminator="Condition"): # pylint: disable=too-many-instance-attributes + """Detailed information about conditions, problems or diagnoses + Based on `FHIR Condition `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.radiologyinsights.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.radiologyinsights.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.radiologyinsights.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "Condition". + :vartype resource_type: str + :ivar identifier: External Ids for this condition. + :vartype identifier: list[~azure.healthinsights.radiologyinsights.models.Identifier] + :ivar clinical_status: active | recurrence | relapse | inactive | remission | resolved. + :vartype clinical_status: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar verification_status: unconfirmed | provisional | differential | confirmed | refuted | + entered-in-error. + :vartype verification_status: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar category: problem-list-item | encounter-diagnosis. + :vartype category: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar severity: Subjective severity of condition. + :vartype severity: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar code: Identification of the condition, problem or diagnosis. + :vartype code: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar body_site: Anatomical location, if relevant. + :vartype body_site: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar encounter: Encounter created as part of. + :vartype encounter: ~azure.healthinsights.radiologyinsights.models.Reference + :ivar onset_date_time: Estimated or actual date, date-time, or age. + :vartype onset_date_time: str + :ivar onset_age: Estimated or actual date, date-time, or age. + :vartype onset_age: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar onset_period: Estimated or actual date, date-time, or age. + :vartype onset_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar onset_range: Estimated or actual date, date-time, or age. + :vartype onset_range: ~azure.healthinsights.radiologyinsights.models.Range + :ivar onset_string: Estimated or actual date, date-time, or age. + :vartype onset_string: str + :ivar abatement_date_time: When in resolution/remission. + :vartype abatement_date_time: str + :ivar abatement_age: When in resolution/remission. + :vartype abatement_age: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar abatement_period: When in resolution/remission. + :vartype abatement_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar abatement_range: When in resolution/remission. + :vartype abatement_range: ~azure.healthinsights.radiologyinsights.models.Range + :ivar abatement_string: When in resolution/remission. + :vartype abatement_string: str + :ivar recorded_date: Date record was first recorded. + :vartype recorded_date: str + :ivar stage: stge/grade, usually assessed formally. + :vartype stage: list[~azure.healthinsights.radiologyinsights.models.ConditionStage] + :ivar note: Additional information about the Condition. + :vartype note: list[~azure.healthinsights.radiologyinsights.models.Annotation] + """ + + resource_type: Literal["Condition"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"Condition\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """External Ids for this condition.""" + clinical_status: Optional["_models.CodeableConcept"] = rest_field(name="clinicalStatus") + """active | recurrence | relapse | inactive | remission | resolved.""" + verification_status: Optional["_models.CodeableConcept"] = rest_field(name="verificationStatus") + """unconfirmed | provisional | differential | confirmed | refuted | entered-in-error.""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """problem-list-item | encounter-diagnosis.""" + severity: Optional["_models.CodeableConcept"] = rest_field() + """Subjective severity of condition.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Identification of the condition, problem or diagnosis.""" + body_site: Optional[List["_models.CodeableConcept"]] = rest_field(name="bodySite") + """Anatomical location, if relevant.""" + encounter: Optional["_models.Reference"] = rest_field() + """Encounter created as part of.""" + onset_date_time: Optional[str] = rest_field(name="onsetDateTime") + """Estimated or actual date, date-time, or age.""" + onset_age: Optional["_models.Quantity"] = rest_field(name="onsetAge") + """Estimated or actual date, date-time, or age.""" + onset_period: Optional["_models.Period"] = rest_field(name="onsetPeriod") + """Estimated or actual date, date-time, or age.""" + onset_range: Optional["_models.Range"] = rest_field(name="onsetRange") + """Estimated or actual date, date-time, or age.""" + onset_string: Optional[str] = rest_field(name="onsetString") + """Estimated or actual date, date-time, or age.""" + abatement_date_time: Optional[str] = rest_field(name="abatementDateTime") + """When in resolution/remission.""" + abatement_age: Optional["_models.Quantity"] = rest_field(name="abatementAge") + """When in resolution/remission.""" + abatement_period: Optional["_models.Period"] = rest_field(name="abatementPeriod") + """When in resolution/remission.""" + abatement_range: Optional["_models.Range"] = rest_field(name="abatementRange") + """When in resolution/remission.""" + abatement_string: Optional[str] = rest_field(name="abatementString") + """When in resolution/remission.""" + recorded_date: Optional[str] = rest_field(name="recordedDate") + """Date record was first recorded.""" + stage: Optional[List["_models.ConditionStage"]] = rest_field() + """stge/grade, usually assessed formally.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Additional information about the Condition.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + clinical_status: Optional["_models.CodeableConcept"] = None, + verification_status: Optional["_models.CodeableConcept"] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + severity: Optional["_models.CodeableConcept"] = None, + code: Optional["_models.CodeableConcept"] = None, + body_site: Optional[List["_models.CodeableConcept"]] = None, + encounter: Optional["_models.Reference"] = None, + onset_date_time: Optional[str] = None, + onset_age: Optional["_models.Quantity"] = None, + onset_period: Optional["_models.Period"] = None, + onset_range: Optional["_models.Range"] = None, + onset_string: Optional[str] = None, + abatement_date_time: Optional[str] = None, + abatement_age: Optional["_models.Quantity"] = None, + abatement_period: Optional["_models.Period"] = None, + abatement_range: Optional["_models.Range"] = None, + abatement_string: Optional[str] = None, + recorded_date: Optional[str] = None, + stage: Optional[List["_models.ConditionStage"]] = None, + note: Optional[List["_models.Annotation"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.resource_type: Literal["Condition"] = "Condition" + + +class ConditionStage(_model_base.Model): + """Stage/grade, usually assessed formally + Based on `FHIR Condition.Stage `_. + + :ivar summary: Simple summary (disease specific). + :vartype summary: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar type: Kind of staging. + :vartype type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + """ + + summary: Optional["_models.CodeableConcept"] = rest_field() + """Simple summary (disease specific).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Kind of staging.""" + + @overload + def __init__( + self, + *, + summary: Optional["_models.CodeableConcept"] = None, + type: Optional["_models.CodeableConcept"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ContactDetail(Element): + """Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail). + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar name: Name of an individual to contact. + :vartype name: str + :ivar telecom: Contact details for individual or organization. + :vartype telecom: list[~azure.healthinsights.radiologyinsights.models.ContactPoint] + """ + + name: Optional[str] = rest_field() + """Name of an individual to contact.""" + telecom: Optional[List["_models.ContactPoint"]] = rest_field() + """Contact details for individual or organization.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + name: Optional[str] = None, + telecom: Optional[List["_models.ContactPoint"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ContactPoint(_model_base.Model): + """Details for all kinds of technology mediated contact points for a person or organization, + including telephone, email, etc. + See https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint. + + :ivar system: phone | fax | email | pager | url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and "other". + :vartype system: str or ~azure.healthinsights.radiologyinsights.models.ContactPointSystem + :ivar value: The actual contact point details. + :vartype value: str + :ivar use: home | work | temp | old | mobile - purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + :vartype use: str or ~azure.healthinsights.radiologyinsights.models.ContactPointUse + :ivar rank: Specify preferred order of use (1 = highest). + :vartype rank: int + :ivar period: Time period when the contact point was/is in use. + :vartype period: ~azure.healthinsights.radiologyinsights.models.Period + """ + + system: Optional[Union[str, "_models.ContactPointSystem"]] = rest_field() + """phone | fax | email | pager | url | sms | other. Known values are: \"phone\", \"fax\", + \"email\", \"pager\", \"url\", \"sms\", and \"other\".""" + value: Optional[str] = rest_field() + """The actual contact point details.""" + use: Optional[Union[str, "_models.ContactPointUse"]] = rest_field() + """home | work | temp | old | mobile - purpose of this contact point. Known values are: \"home\", + \"work\", \"temp\", \"old\", and \"mobile\".""" + rank: Optional[int] = rest_field() + """Specify preferred order of use (1 = highest).""" + period: Optional["_models.Period"] = rest_field() + """Time period when the contact point was/is in use.""" + + @overload + def __init__( + self, + *, + system: Optional[Union[str, "_models.ContactPointSystem"]] = None, + value: Optional[str] = None, + use: Optional[Union[str, "_models.ContactPointUse"]] = None, + rank: Optional[int] = None, + period: Optional["_models.Period"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CriticalResult(_model_base.Model): + """Critical Result consists of two properties. + + All required parameters must be populated in order to send to server. + + :ivar description: Description : medical problem. Required. + :vartype description: str + :ivar finding: Finding linked to the critical result. + :vartype finding: ~azure.healthinsights.radiologyinsights.models.Observation + """ + + description: str = rest_field() + """Description : medical problem. Required.""" + finding: Optional["_models.Observation"] = rest_field() + """Finding linked to the critical result.""" + + @overload + def __init__( + self, + *, + description: str, + finding: Optional["_models.Observation"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CriticalResultInference(RadiologyInsightsInference, discriminator="criticalResult"): + """Critical results refer to findings of utmost importance that may require timely attention due + to their potential impact on patient care. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Critical finding inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.CRITICAL_RESULT + :ivar result: The complete Critical Result, as outlined below, will be reused for the + recommendation. Required. + :vartype result: ~azure.healthinsights.radiologyinsights.models.CriticalResult + """ + + kind: Literal[RadiologyInsightsInferenceType.CRITICAL_RESULT] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Critical finding inference type""" + result: "_models.CriticalResult" = rest_field() + """The complete Critical Result, as outlined below, will be reused for the recommendation. + Required.""" + + @overload + def __init__( + self, + *, + result: "_models.CriticalResult", + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal[ + RadiologyInsightsInferenceType.CRITICAL_RESULT + ] = RadiologyInsightsInferenceType.CRITICAL_RESULT + + +class DocumentAdministrativeMetadata(_model_base.Model): + """Document administrative metadata. + + :ivar ordered_procedures: List of procedure information associated with the document. + :vartype ordered_procedures: + list[~azure.healthinsights.radiologyinsights.models.OrderedProcedure] + :ivar encounter_id: Reference to the encounter associated with the document. + :vartype encounter_id: str + """ + + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = rest_field(name="orderedProcedures") + """List of procedure information associated with the document.""" + encounter_id: Optional[str] = rest_field(name="encounterId") + """Reference to the encounter associated with the document.""" + + @overload + def __init__( + self, + *, + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = None, + encounter_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAuthor(_model_base.Model): + """Document author. + + :ivar id: author id. + :vartype id: str + :ivar full_name: Text representation of the full name. + :vartype full_name: str + """ + + id: Optional[str] = rest_field() + """author id.""" + full_name: Optional[str] = rest_field(name="fullName") + """Text representation of the full name.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + full_name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentContent(_model_base.Model): + """The content of the patient document. + + All required parameters must be populated in order to send to server. + + :ivar source_type: The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: "inline" and "reference". + :vartype source_type: str or + ~azure.healthinsights.radiologyinsights.models.DocumentContentSourceType + :ivar value: The content of the document, given either inline (as a string) or as a reference + (URI). Required. + :vartype value: str + """ + + source_type: Union[str, "_models.DocumentContentSourceType"] = rest_field(name="sourceType") + """The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: \"inline\" and \"reference\".""" + value: str = rest_field() + """The content of the document, given either inline (as a string) or as a reference (URI). + Required.""" + + @overload + def __init__( + self, + *, + source_type: Union[str, "_models.DocumentContentSourceType"], + value: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Encounter(_model_base.Model): + """visit/encounter information. + + All required parameters must be populated in order to send to server. + + :ivar id: The id of the visit. Required. + :vartype id: str + :ivar period: Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end + to indicate the discharge time. + :vartype period: ~azure.healthinsights.radiologyinsights.models.TimePeriod + :ivar class_property: The class of the encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + :vartype class_property: str or ~azure.healthinsights.radiologyinsights.models.EncounterClass + """ + + id: str = rest_field() + """The id of the visit. Required.""" + period: Optional["_models.TimePeriod"] = rest_field() + """Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to + indicate the discharge time.""" + class_property: Optional[Union[str, "_models.EncounterClass"]] = rest_field(name="class") + """The class of the encounter. Known values are: \"inpatient\", \"ambulatory\", \"observation\", + \"emergency\", \"virtual\", and \"healthHome\".""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + period: Optional["_models.TimePeriod"] = None, + class_property: Optional[Union[str, "_models.EncounterClass"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Error(_model_base.Model): + """The error object. + + All required parameters must be populated in order to send to server. + + :ivar code: One of a server-defined set of error codes. Required. + :vartype code: str + :ivar message: A human-readable representation of the error. Required. + :vartype message: str + :ivar target: The target of the error. + :vartype target: str + :ivar details: An array of details about specific errors that led to this reported error. + :vartype details: list[~azure.healthinsights.radiologyinsights.models.Error] + :ivar innererror: An object containing more specific information than the current object about + the error. + :vartype innererror: ~azure.healthinsights.radiologyinsights.models.InnerError + """ + + code: str = rest_field() + """One of a server-defined set of error codes. Required.""" + message: str = rest_field() + """A human-readable representation of the error. Required.""" + target: Optional[str] = rest_field() + """The target of the error.""" + details: Optional[List["_models.Error"]] = rest_field() + """An array of details about specific errors that led to this reported error.""" + innererror: Optional["_models.InnerError"] = rest_field() + """An object containing more specific information than the current object about the error.""" + + @overload + def __init__( + self, + *, + code: str, + message: str, + target: Optional[str] = None, + details: Optional[List["_models.Error"]] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Extension(Element): # pylint: disable=too-many-instance-attributes + """Base for all elements + Based on `FHIR Element `_. + + All required parameters must be populated in order to send to server. + + :ivar url: Source of the definition for the extension code - a logical name or a URL. Required. + :vartype url: str + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.radiologyinsights.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.radiologyinsights.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.radiologyinsights.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.radiologyinsights.models.Reference + """ + + url: str = rest_field() + """Source of the definition for the extension code - a logical name or a URL. Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + + @overload + def __init__( + self, + *, + url: str, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class FindingInference(RadiologyInsightsInference, discriminator="finding"): + """Findings in a radiology report typically describe abnormalities, lesions, or other notable + observations related to the anatomy or pathology of the imaged area. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Finding inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.FINDING + :ivar finding: Finding data : contains extensions, fields and components linked with the + finding. Required. + :vartype finding: ~azure.healthinsights.radiologyinsights.models.Observation + """ + + kind: Literal[RadiologyInsightsInferenceType.FINDING] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Finding inference type""" + finding: "_models.Observation" = rest_field() + """Finding data : contains extensions, fields and components linked with the finding. Required.""" + + @overload + def __init__( + self, + *, + finding: "_models.Observation", + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal[RadiologyInsightsInferenceType.FINDING] = RadiologyInsightsInferenceType.FINDING + + +class FindingOptions(_model_base.Model): + """Finding options. + + :ivar provide_focused_sentence_evidence: If this is true, provide the sentence that contains + the first token of the finding's clinical indicator (i.e. the medical problem), if there is + one. This sentence is provided as an extension with url 'ci_sentence', next to the token + evidence. Default is false. + :vartype provide_focused_sentence_evidence: bool + """ + + provide_focused_sentence_evidence: Optional[bool] = rest_field(name="provideFocusedSentenceEvidence") + """If this is true, provide the sentence that contains the first token of the finding's clinical + indicator (i.e. the medical problem), if there is one. This sentence is provided as an + extension with url 'ci_sentence', next to the token evidence. Default is false.""" + + @overload + def __init__( + self, + *, + provide_focused_sentence_evidence: Optional[bool] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class FollowupCommunicationInference(RadiologyInsightsInference, discriminator="followupCommunication"): + """Follow-up communication involves the exchange of important information, recommendations, or + updates between radiologists and other healthcare professionals involved in a patient's care. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Followup Communication inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.FOLLOWUP_COMMUNICATION + :ivar date_time: Communication date and time. + :vartype date_time: list[~datetime.datetime] + :ivar recipient: Recipient of the communication. + :vartype recipient: list[str or + ~azure.healthinsights.radiologyinsights.models.MedicalProfessionalType] + :ivar was_acknowledged: Communication was acknowledged. Required. + :vartype was_acknowledged: bool + """ + + kind: Literal[RadiologyInsightsInferenceType.FOLLOWUP_COMMUNICATION] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Followup Communication inference type""" + date_time: Optional[List[datetime.datetime]] = rest_field(name="dateTime", format="rfc3339") + """Communication date and time.""" + recipient: Optional[List[Union[str, "_models.MedicalProfessionalType"]]] = rest_field() + """Recipient of the communication.""" + was_acknowledged: bool = rest_field(name="wasAcknowledged") + """Communication was acknowledged. Required.""" + + @overload + def __init__( + self, + *, + was_acknowledged: bool, + extension: Optional[List["_models.Extension"]] = None, + date_time: Optional[List[datetime.datetime]] = None, + recipient: Optional[List[Union[str, "_models.MedicalProfessionalType"]]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal[ + RadiologyInsightsInferenceType.FOLLOWUP_COMMUNICATION + ] = RadiologyInsightsInferenceType.FOLLOWUP_COMMUNICATION + + +class FollowupRecommendationInference(RadiologyInsightsInference, discriminator="followupRecommendation"): + """Follow-up recommendations offer guidance to healthcare providers on managing and monitoring + patients based on the findings of imaging studies. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Recommendation inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.FOLLOWUP_RECOMMENDATION + :ivar effective_date_time: Date and time are displayed when the procedure is recommended to be + done at a specific point in time. + :vartype effective_date_time: str + :ivar effective_period: The period is shown if a specific period is mentioned, with a start and + end date-time. + :vartype effective_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar findings: Findings related to the recommendation. + :vartype findings: list[~azure.healthinsights.radiologyinsights.models.RecommendationFinding] + :ivar is_conditional: The conditional value indicates whether or not the sentence containing + the recommendation includes a conditional statement. Keywords for conditional statements + include 'if', 'when', 'unless', and so on. Required. + :vartype is_conditional: bool + :ivar is_option: The option value indicates whether or not the sentence containing the + recommendation includes an optional statement. Keywords for optional statements include + 'recommend', 'consider', and so on. Required. + :vartype is_option: bool + :ivar is_guideline: The guideline value indicates whether or not the recommendation is part of + a guideline section that compiles all recommendations applicable to various findings. Required. + :vartype is_guideline: bool + :ivar is_hedging: Hedging refers to ambiguous, vague or imprecise language within the sentence + of the recommendation. Keywords for hedging are 'can be','may be',and so on. Required. + :vartype is_hedging: bool + :ivar recommended_procedure: The procedure recommendation can be a generic procedure or an + imaging procedure. Required. + :vartype recommended_procedure: + ~azure.healthinsights.radiologyinsights.models.ProcedureRecommendation + """ + + kind: Literal[RadiologyInsightsInferenceType.FOLLOWUP_RECOMMENDATION] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Recommendation inference type""" + effective_date_time: Optional[str] = rest_field(name="effectiveDateTime") + """Date and time are displayed when the procedure is recommended to be done at a specific point in + time.""" + effective_period: Optional["_models.Period"] = rest_field(name="effectivePeriod") + """The period is shown if a specific period is mentioned, with a start and end date-time.""" + findings: Optional[List["_models.RecommendationFinding"]] = rest_field() + """Findings related to the recommendation.""" + is_conditional: bool = rest_field(name="isConditional") + """The conditional value indicates whether or not the sentence containing the recommendation + includes a conditional statement. Keywords for conditional statements include 'if', 'when', + 'unless', and so on. Required.""" + is_option: bool = rest_field(name="isOption") + """The option value indicates whether or not the sentence containing the recommendation includes + an optional statement. Keywords for optional statements include 'recommend', 'consider', and so + on. Required.""" + is_guideline: bool = rest_field(name="isGuideline") + """The guideline value indicates whether or not the recommendation is part of a guideline section + that compiles all recommendations applicable to various findings. Required.""" + is_hedging: bool = rest_field(name="isHedging") + """Hedging refers to ambiguous, vague or imprecise language within the sentence of the + recommendation. Keywords for hedging are 'can be','may be',and so on. Required.""" + recommended_procedure: "_models.ProcedureRecommendation" = rest_field(name="recommendedProcedure") + """The procedure recommendation can be a generic procedure or an imaging procedure. Required.""" + + @overload + def __init__( + self, + *, + is_conditional: bool, + is_option: bool, + is_guideline: bool, + is_hedging: bool, + recommended_procedure: "_models.ProcedureRecommendation", + extension: Optional[List["_models.Extension"]] = None, + effective_date_time: Optional[str] = None, + effective_period: Optional["_models.Period"] = None, + findings: Optional[List["_models.RecommendationFinding"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal[ + RadiologyInsightsInferenceType.FOLLOWUP_RECOMMENDATION + ] = RadiologyInsightsInferenceType.FOLLOWUP_RECOMMENDATION + + +class FollowupRecommendationOptions(_model_base.Model): + """Follow-up recommendation options. + + :ivar include_recommendations_with_no_specified_modality: Include/Exclude follow-up + recommendations without a specific radiology procedure. Default is false. + :vartype include_recommendations_with_no_specified_modality: bool + :ivar include_recommendations_in_references: Include/Exclude follow-up recommendations in + references to a guideline or article. Default is false. + :vartype include_recommendations_in_references: bool + :ivar provide_focused_sentence_evidence: If this is true, provide one or more sentences as + evidence for the recommendation, next to the token evidence. The start and end positions of + these sentences will be put in an extension with url 'modality_sentences'. Default is false. + :vartype provide_focused_sentence_evidence: bool + """ + + include_recommendations_with_no_specified_modality: Optional[bool] = rest_field( + name="includeRecommendationsWithNoSpecifiedModality" + ) + """Include/Exclude follow-up recommendations without a specific radiology procedure. Default is + false.""" + include_recommendations_in_references: Optional[bool] = rest_field(name="includeRecommendationsInReferences") + """Include/Exclude follow-up recommendations in references to a guideline or article. Default is + false.""" + provide_focused_sentence_evidence: Optional[bool] = rest_field(name="provideFocusedSentenceEvidence") + """If this is true, provide one or more sentences as evidence for the recommendation, next to the + token evidence. The start and end positions of these sentences will be put in an extension with + url 'modality_sentences'. Default is false.""" + + @overload + def __init__( + self, + *, + include_recommendations_with_no_specified_modality: Optional[bool] = None, + include_recommendations_in_references: Optional[bool] = None, + provide_focused_sentence_evidence: Optional[bool] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ProcedureRecommendation(_model_base.Model): + """The procedure recommendation can be a generic procedure or an imaging procedure. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + GenericProcedureRecommendation, ImagingProcedureRecommendation + + All required parameters must be populated in order to send to server. + + :ivar kind: Required. Default value is None. + :vartype kind: str + """ + + __mapping__: Dict[str, _model_base.Model] = {} + kind: Literal[None] = rest_discriminator(name="kind") + """Required. Default value is None.""" + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal[None] = None + + +class GenericProcedureRecommendation(ProcedureRecommendation, discriminator="genericProcedureRecommendation"): + """Generic procedure information. + + All required parameters must be populated in order to send to server. + + :ivar kind: Procedure type : generic. Required. Default value is + "genericProcedureRecommendation". + :vartype kind: str + :ivar code: Procedure modality : SNOMED CT code. Required. + :vartype code: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar description: Procedure description : MANAGEMENT PROCEDURE (PROCEDURE) or CONSULTATION + (PROCEDURE) based on SNOMED CT. + :vartype description: str + """ + + kind: Literal["genericProcedureRecommendation"] = rest_discriminator(name="kind") # type: ignore + """Procedure type : generic. Required. Default value is \"genericProcedureRecommendation\".""" + code: "_models.CodeableConcept" = rest_field() + """Procedure modality : SNOMED CT code. Required.""" + description: Optional[str] = rest_field() + """Procedure description : MANAGEMENT PROCEDURE (PROCEDURE) or CONSULTATION (PROCEDURE) based on + SNOMED CT.""" + + @overload + def __init__( + self, + *, + code: "_models.CodeableConcept", + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal["genericProcedureRecommendation"] = "genericProcedureRecommendation" + + +class HealthInsightsOperationStatus(_model_base.Model): + """Provides status details for long running operations. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: The unique ID of the operation. Required. + :vartype id: str + :ivar status: The status of the operation. Required. Known values are: "notStarted", "running", + "succeeded", "failed", and "canceled". + :vartype status: str or ~azure.healthinsights.radiologyinsights.models.JobStatus + :ivar created_date_time: The date and time when the processing job was created. + :vartype created_date_time: ~datetime.datetime + :ivar expiration_date_time: The date and time when the processing job is set to expire. + :vartype expiration_date_time: ~datetime.datetime + :ivar last_update_date_time: The date and time when the processing job was last updated. + :vartype last_update_date_time: ~datetime.datetime + :ivar error: Error object that describes the error when status is "Failed". + :vartype error: ~azure.healthinsights.radiologyinsights.models.Error + :ivar result: The result of the operation. + :vartype result: + ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult + """ + + id: str = rest_field(visibility=["read"]) + """The unique ID of the operation. Required.""" + status: Union[str, "_models.JobStatus"] = rest_field(visibility=["read"]) + """The status of the operation. Required. Known values are: \"notStarted\", \"running\", + \"succeeded\", \"failed\", and \"canceled\".""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was created.""" + expiration_date_time: Optional[datetime.datetime] = rest_field( + name="expirationDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job is set to expire.""" + last_update_date_time: Optional[datetime.datetime] = rest_field( + name="lastUpdateDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was last updated.""" + error: Optional["_models.Error"] = rest_field() + """Error object that describes the error when status is \"Failed\".""" + result: Optional["_models.RadiologyInsightsInferenceResult"] = rest_field() + """The result of the operation.""" + + @overload + def __init__( + self, + *, + error: Optional["_models.Error"] = None, + result: Optional["_models.RadiologyInsightsInferenceResult"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Identifier(Element): + """An identifier intended for computation + Based on `FHIR Identifier `_. + + :ivar use: usual | official | temp | secondary | old (If known). + :vartype use: str + :ivar type: Description of identifier. + :vartype type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar system: The namespace for the identifier value. + :vartype system: str + :ivar value: The value that is unique. + :vartype value: str + :ivar period: Time period when id is/was valid for use. + :vartype period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar assigner: Organization that issued id (may be just text). + :vartype assigner: ~azure.healthinsights.radiologyinsights.models.Reference + """ + + use: Optional[str] = rest_field() + """usual | official | temp | secondary | old (If known).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Description of identifier.""" + system: Optional[str] = rest_field() + """The namespace for the identifier value.""" + value: Optional[str] = rest_field() + """The value that is unique.""" + period: Optional["_models.Period"] = rest_field() + """Time period when id is/was valid for use.""" + assigner: Optional["_models.Reference"] = rest_field() + """Organization that issued id (may be just text).""" + + @overload + def __init__( + self, + *, + use: Optional[str] = None, + type: Optional["_models.CodeableConcept"] = None, + system: Optional[str] = None, + value: Optional[str] = None, + period: Optional["_models.Period"] = None, + assigner: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ImagingProcedure(_model_base.Model): + """Imaging procedure. + + All required parameters must be populated in order to send to server. + + :ivar modality: Modality : SNOMED CT code. Required. + :vartype modality: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar anatomy: Anatomy : SNOMED CT code. Required. + :vartype anatomy: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar laterality: Laterality : SNOMED CT code. + :vartype laterality: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar contrast: Contrast : see RadiologyCodeWithTypes (below). + :vartype contrast: ~azure.healthinsights.radiologyinsights.models.RadiologyCodeWithTypes + :ivar view: View : see RadiologyCodeWithTypes (below). + :vartype view: ~azure.healthinsights.radiologyinsights.models.RadiologyCodeWithTypes + """ + + modality: "_models.CodeableConcept" = rest_field() + """Modality : SNOMED CT code. Required.""" + anatomy: "_models.CodeableConcept" = rest_field() + """Anatomy : SNOMED CT code. Required.""" + laterality: Optional["_models.CodeableConcept"] = rest_field() + """Laterality : SNOMED CT code.""" + contrast: Optional["_models.RadiologyCodeWithTypes"] = rest_field() + """Contrast : see RadiologyCodeWithTypes (below).""" + view: Optional["_models.RadiologyCodeWithTypes"] = rest_field() + """View : see RadiologyCodeWithTypes (below).""" + + @overload + def __init__( + self, + *, + modality: "_models.CodeableConcept", + anatomy: "_models.CodeableConcept", + laterality: Optional["_models.CodeableConcept"] = None, + contrast: Optional["_models.RadiologyCodeWithTypes"] = None, + view: Optional["_models.RadiologyCodeWithTypes"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ImagingProcedureRecommendation(ProcedureRecommendation, discriminator="imagingProcedureRecommendation"): + """Imaging procedures. + + All required parameters must be populated in order to send to server. + + :ivar kind: Procedure type : imaging. Required. Default value is + "imagingProcedureRecommendation". + :vartype kind: str + :ivar procedure_codes: LOINC codes for the procedure. + :vartype procedure_codes: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar imaging_procedures: Imaging procedures. Required. + :vartype imaging_procedures: + list[~azure.healthinsights.radiologyinsights.models.ImagingProcedure] + """ + + kind: Literal["imagingProcedureRecommendation"] = rest_discriminator(name="kind") # type: ignore + """Procedure type : imaging. Required. Default value is \"imagingProcedureRecommendation\".""" + procedure_codes: Optional[List["_models.CodeableConcept"]] = rest_field(name="procedureCodes") + """LOINC codes for the procedure.""" + imaging_procedures: List["_models.ImagingProcedure"] = rest_field(name="imagingProcedures") + """Imaging procedures. Required.""" + + @overload + def __init__( + self, + *, + imaging_procedures: List["_models.ImagingProcedure"], + procedure_codes: Optional[List["_models.CodeableConcept"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal["imagingProcedureRecommendation"] = "imagingProcedureRecommendation" + + +class InnerError(_model_base.Model): + """An object containing more specific information about the error. As per Microsoft One API + guidelines - + https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + + :ivar code: One of a server-defined set of error codes. + :vartype code: str + :ivar innererror: Inner error. + :vartype innererror: ~azure.healthinsights.radiologyinsights.models.InnerError + """ + + code: Optional[str] = rest_field() + """One of a server-defined set of error codes.""" + innererror: Optional["_models.InnerError"] = rest_field() + """Inner error.""" + + @overload + def __init__( + self, + *, + code: Optional[str] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class LateralityDiscrepancyInference(RadiologyInsightsInference, discriminator="lateralityDiscrepancy"): + """A laterality mismatch occurs when there is a discrepancy between the clinical documentation and + the ordered procedure (orderLateralityMismatch), a contradiction within the clinical document + (textLateralityContradiction), or when no laterality is mentioned (textLateralityMissing). + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Laterality discrepancy inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.LATERALITY_DISCREPANCY + :ivar laterality_indication: Laterality indication : SNOMED CT code for laterality qualifier + value. + :vartype laterality_indication: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar discrepancy_type: Mismatch type : orderLateralityMismatch, textLateralityContradiction, + textLateralityMissing. Required. Known values are: "orderLateralityMismatch", + "textLateralityContradiction", and "textLateralityMissing". + :vartype discrepancy_type: str or + ~azure.healthinsights.radiologyinsights.models.LateralityDiscrepancyType + """ + + kind: Literal[RadiologyInsightsInferenceType.LATERALITY_DISCREPANCY] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Laterality discrepancy inference type""" + laterality_indication: Optional["_models.CodeableConcept"] = rest_field(name="lateralityIndication") + """Laterality indication : SNOMED CT code for laterality qualifier value.""" + discrepancy_type: Union[str, "_models.LateralityDiscrepancyType"] = rest_field(name="discrepancyType") + """Mismatch type : orderLateralityMismatch, textLateralityContradiction, textLateralityMissing. + Required. Known values are: \"orderLateralityMismatch\", \"textLateralityContradiction\", and + \"textLateralityMissing\".""" + + @overload + def __init__( + self, + *, + discrepancy_type: Union[str, "_models.LateralityDiscrepancyType"], + extension: Optional[List["_models.Extension"]] = None, + laterality_indication: Optional["_models.CodeableConcept"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal[ + RadiologyInsightsInferenceType.LATERALITY_DISCREPANCY + ] = RadiologyInsightsInferenceType.LATERALITY_DISCREPANCY + + +class LimitedOrderDiscrepancyInference(RadiologyInsightsInference, discriminator="limitedOrderDiscrepancy"): + """A limited order discrepancy occurs when there is a limited order, but all body parts and + measurements that are needed for a complete order are present in the document. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Limited order discrepancy inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.LIMITED_ORDER_DISCREPANCY + :ivar order_type: Order type : CPT ultrasound complete code for abdomen, retroperitoneal, + pelvis or breast. Required. + :vartype order_type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar present_body_parts: List of body parts found in the document : SNOMED CT codes. + :vartype present_body_parts: + list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar present_body_part_measurements: List of body parts that are measured according to the + document : SNOMED CT codes. + :vartype present_body_part_measurements: + list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + """ + + kind: Literal[RadiologyInsightsInferenceType.LIMITED_ORDER_DISCREPANCY] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Limited order discrepancy inference type""" + order_type: "_models.CodeableConcept" = rest_field(name="orderType") + """Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast. + Required.""" + present_body_parts: Optional[List["_models.CodeableConcept"]] = rest_field(name="presentBodyParts") + """List of body parts found in the document : SNOMED CT codes.""" + present_body_part_measurements: Optional[List["_models.CodeableConcept"]] = rest_field( + name="presentBodyPartMeasurements" + ) + """List of body parts that are measured according to the document : SNOMED CT codes.""" + + @overload + def __init__( + self, + *, + order_type: "_models.CodeableConcept", + extension: Optional[List["_models.Extension"]] = None, + present_body_parts: Optional[List["_models.CodeableConcept"]] = None, + present_body_part_measurements: Optional[List["_models.CodeableConcept"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal[ + RadiologyInsightsInferenceType.LIMITED_ORDER_DISCREPANCY + ] = RadiologyInsightsInferenceType.LIMITED_ORDER_DISCREPANCY + + +class Meta(_model_base.Model): + """Metadata about a resource + Based on `FHIR Meta `_. + + :ivar version_id: The version specific identifier, as it appears in the version portion of the + URL. This value changes when the resource is created, updated, or deleted. + :vartype version_id: str + :ivar last_updated: When the resource last changed - e.g. when the version changed. + :vartype last_updated: str + :ivar source: A uri that identifies the source system of the resource. This provides a minimal + amount of Provenance information that can be used to track or differentiate the source of + information in the resource. The source may identify another FHIR server, document, message, + database, etc. + :vartype source: str + :ivar profile: A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_. + :vartype profile: list[str] + :ivar security: Security labels applied to this resource. These tags connect specific resources + to the overall security policy and infrastructure. + :vartype security: list[~azure.healthinsights.radiologyinsights.models.Coding] + :ivar tag: Tags applied to this resource. Tags are intended to be used to identify and relate + resources to process and workflow, and applications are not required to consider the tags when + interpreting the meaning of a resource. + :vartype tag: list[~azure.healthinsights.radiologyinsights.models.Coding] + """ + + version_id: Optional[str] = rest_field(name="versionId") + """The version specific identifier, as it appears in the version portion of the URL. This value + changes when the resource is created, updated, or deleted.""" + last_updated: Optional[str] = rest_field(name="lastUpdated") + """When the resource last changed - e.g. when the version changed.""" + source: Optional[str] = rest_field() + """A uri that identifies the source system of the resource. This provides a minimal amount of + Provenance information that can be used to track or differentiate the source of information in + the resource. The source may identify another FHIR server, document, message, database, etc.""" + profile: Optional[List[str]] = rest_field() + """A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_.""" + security: Optional[List["_models.Coding"]] = rest_field() + """Security labels applied to this resource. These tags connect specific resources to the overall + security policy and infrastructure.""" + tag: Optional[List["_models.Coding"]] = rest_field() + """Tags applied to this resource. Tags are intended to be used to identify and relate resources to + process and workflow, and applications are not required to consider the tags when interpreting + the meaning of a resource.""" + + @overload + def __init__( + self, + *, + version_id: Optional[str] = None, + last_updated: Optional[str] = None, + source: Optional[str] = None, + profile: Optional[List[str]] = None, + security: Optional[List["_models.Coding"]] = None, + tag: Optional[List["_models.Coding"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Narrative(Element): + """Any resource that is a `DomainResource `_ may + include a human-readable narrative that contains a summary of the resource and may be used to + represent the content of the resource to a human. + Based on `FHIR Narrative `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar status: generated, extensions, additional, empty. Required. + :vartype status: str + :ivar div: xhtml. Required. + :vartype div: str + """ + + status: str = rest_field() + """generated, extensions, additional, empty. Required.""" + div: str = rest_field() + """xhtml. Required.""" + + @overload + def __init__( + self, + *, + status: str, + div: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Observation(DomainResource): # pylint: disable=too-many-instance-attributes + """Detailed information about observations + Based on `FHIR Observation `_. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.radiologyinsights.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.radiologyinsights.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.radiologyinsights.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "Observation". + :vartype resource_type: str + :ivar identifier: Business Identifier for observation. + :vartype identifier: list[~azure.healthinsights.radiologyinsights.models.Identifier] + :ivar status: registered | preliminary | final | amended +. Required. Known values are: + "registered", "preliminary", "final", "amended", "corrected", "cancelled", "entered-in-error", + and "unknown". + :vartype status: str or + ~azure.healthinsights.radiologyinsights.models.ObservationStatusCodeType + :ivar category: Classification of type of observation. + :vartype category: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar code: Type of observation (code / type). Required. + :vartype code: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar subject: Who and/or what the observation is about. + :vartype subject: ~azure.healthinsights.radiologyinsights.models.Reference + :ivar encounter: Healthcare event during which this observation is made. + :vartype encounter: ~azure.healthinsights.radiologyinsights.models.Reference + :ivar effective_date_time: Clinically relevant time/time-period for observation. + :vartype effective_date_time: str + :ivar effective_period: Clinically relevant time/time-period for observation. + :vartype effective_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar effective_instant: Clinically relevant time/time-period for observation. + :vartype effective_instant: str + :ivar issued: Date/Time this version was made available. + :vartype issued: str + :ivar value_quantity: Actual result. + :vartype value_quantity: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar value_codeable_concept: Actual result. + :vartype value_codeable_concept: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar value_string: Actual result. + :vartype value_string: str + :ivar value_boolean: Actual result. + :vartype value_boolean: bool + :ivar value_integer: Actual result. + :vartype value_integer: int + :ivar value_range: Actual result. + :vartype value_range: ~azure.healthinsights.radiologyinsights.models.Range + :ivar value_ratio: Actual result. + :vartype value_ratio: ~azure.healthinsights.radiologyinsights.models.Ratio + :ivar value_sampled_data: Actual result. + :vartype value_sampled_data: ~azure.healthinsights.radiologyinsights.models.SampledData + :ivar value_time: Actual result. + :vartype value_time: ~datetime.time + :ivar value_date_time: Actual result. + :vartype value_date_time: str + :ivar value_period: Actual result. + :vartype value_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar data_absent_reason: Why the result is missing. + :vartype data_absent_reason: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar interpretation: High, low, normal, etc. + :vartype interpretation: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar note: Comments about the observation. + :vartype note: list[~azure.healthinsights.radiologyinsights.models.Annotation] + :ivar body_site: Observed body part. + :vartype body_site: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar method: How it was done. + :vartype method: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar reference_range: Provides guide for interpretation. + :vartype reference_range: + list[~azure.healthinsights.radiologyinsights.models.ObservationReferenceRange] + :ivar has_member: Related resource that belongs to the Observation group. + :vartype has_member: list[~azure.healthinsights.radiologyinsights.models.Reference] + :ivar derived_from: Related measurements the observation is made from. + :vartype derived_from: list[~azure.healthinsights.radiologyinsights.models.Reference] + :ivar component: Component results. + :vartype component: list[~azure.healthinsights.radiologyinsights.models.ObservationComponent] + """ + + resource_type: Literal["Observation"] = rest_field(name="resourceType") + """resourceType. Required. Default value is \"Observation\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """Business Identifier for observation.""" + status: Union[str, "_models.ObservationStatusCodeType"] = rest_field() + """registered | preliminary | final | amended +. Required. Known values are: \"registered\", + \"preliminary\", \"final\", \"amended\", \"corrected\", \"cancelled\", \"entered-in-error\", + and \"unknown\".""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """Classification of type of observation.""" + code: "_models.CodeableConcept" = rest_field() + """Type of observation (code / type). Required.""" + subject: Optional["_models.Reference"] = rest_field() + """Who and/or what the observation is about.""" + encounter: Optional["_models.Reference"] = rest_field() + """Healthcare event during which this observation is made.""" + effective_date_time: Optional[str] = rest_field(name="effectiveDateTime") + """Clinically relevant time/time-period for observation.""" + effective_period: Optional["_models.Period"] = rest_field(name="effectivePeriod") + """Clinically relevant time/time-period for observation.""" + effective_instant: Optional[str] = rest_field(name="effectiveInstant") + """Clinically relevant time/time-period for observation.""" + issued: Optional[str] = rest_field() + """Date/Time this version was made available.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Actual result.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Actual result.""" + value_string: Optional[str] = rest_field(name="valueString") + """Actual result.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Actual result.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Actual result.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Actual result.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Actual result.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Actual result.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Actual result.""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Actual result.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Actual result.""" + data_absent_reason: Optional["_models.CodeableConcept"] = rest_field(name="dataAbsentReason") + """Why the result is missing.""" + interpretation: Optional[List["_models.CodeableConcept"]] = rest_field() + """High, low, normal, etc.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Comments about the observation.""" + body_site: Optional["_models.CodeableConcept"] = rest_field(name="bodySite") + """Observed body part.""" + method: Optional["_models.CodeableConcept"] = rest_field() + """How it was done.""" + reference_range: Optional[List["_models.ObservationReferenceRange"]] = rest_field(name="referenceRange") + """Provides guide for interpretation.""" + has_member: Optional[List["_models.Reference"]] = rest_field(name="hasMember") + """Related resource that belongs to the Observation group.""" + derived_from: Optional[List["_models.Reference"]] = rest_field(name="derivedFrom") + """Related measurements the observation is made from.""" + component: Optional[List["_models.ObservationComponent"]] = rest_field() + """Component results.""" + + @overload + def __init__( + self, + *, + status: Union[str, "_models.ObservationStatusCodeType"], + code: "_models.CodeableConcept", + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + subject: Optional["_models.Reference"] = None, + encounter: Optional["_models.Reference"] = None, + effective_date_time: Optional[str] = None, + effective_period: Optional["_models.Period"] = None, + effective_instant: Optional[str] = None, + issued: Optional[str] = None, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + data_absent_reason: Optional["_models.CodeableConcept"] = None, + interpretation: Optional[List["_models.CodeableConcept"]] = None, + note: Optional[List["_models.Annotation"]] = None, + body_site: Optional["_models.CodeableConcept"] = None, + method: Optional["_models.CodeableConcept"] = None, + reference_range: Optional[List["_models.ObservationReferenceRange"]] = None, + has_member: Optional[List["_models.Reference"]] = None, + derived_from: Optional[List["_models.Reference"]] = None, + component: Optional[List["_models.ObservationComponent"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.resource_type: Literal["Observation"] = "Observation" + + +class ObservationComponent(Element): # pylint: disable=too-many-instance-attributes + """Component results + Based on `FHIR Observation.component `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar code: Type of component observation (code / type). Required. + :vartype code: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.radiologyinsights.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.radiologyinsights.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.radiologyinsights.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.radiologyinsights.models.Reference + :ivar data_absent_reason: Why the component result is missing. + :vartype data_absent_reason: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar interpretation: High, low, normal, etc. + :vartype interpretation: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar reference_range: Provides guide for interpretation of component result. + :vartype reference_range: + list[~azure.healthinsights.radiologyinsights.models.ObservationReferenceRange] + """ + + code: "_models.CodeableConcept" = rest_field() + """Type of component observation (code / type). Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + data_absent_reason: Optional["_models.CodeableConcept"] = rest_field(name="dataAbsentReason") + """Why the component result is missing.""" + interpretation: Optional[List["_models.CodeableConcept"]] = rest_field() + """High, low, normal, etc.""" + reference_range: Optional[List["_models.ObservationReferenceRange"]] = rest_field(name="referenceRange") + """Provides guide for interpretation of component result.""" + + @overload + def __init__( + self, + *, + code: "_models.CodeableConcept", + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + data_absent_reason: Optional["_models.CodeableConcept"] = None, + interpretation: Optional[List["_models.CodeableConcept"]] = None, + reference_range: Optional[List["_models.ObservationReferenceRange"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ObservationReferenceRange(_model_base.Model): + """Provides guide for interpretation of component result + Based on `FHIR Observation.referenceRange `_. + + :ivar low: Low Range, if relevant. + :vartype low: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar high: High Range, if relevant. + :vartype high: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar type: Reference range qualifier. + :vartype type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar applies_to: Reference range population. + :vartype applies_to: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar age: Applicable age range, if relevant. + :vartype age: ~azure.healthinsights.radiologyinsights.models.Range + :ivar text: Text based reference range in an observation. + :vartype text: str + """ + + low: Optional["_models.Quantity"] = rest_field() + """Low Range, if relevant.""" + high: Optional["_models.Quantity"] = rest_field() + """High Range, if relevant.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Reference range qualifier.""" + applies_to: Optional[List["_models.CodeableConcept"]] = rest_field(name="appliesTo") + """Reference range population.""" + age: Optional["_models.Range"] = rest_field() + """Applicable age range, if relevant.""" + text: Optional[str] = rest_field() + """Text based reference range in an observation.""" + + @overload + def __init__( + self, + *, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, + type: Optional["_models.CodeableConcept"] = None, + applies_to: Optional[List["_models.CodeableConcept"]] = None, + age: Optional["_models.Range"] = None, + text: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OrderedProcedure(_model_base.Model): + """Procedure information. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar code: Procedure code. + :vartype code: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar description: Procedure description. + :vartype description: str + """ + + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Procedure code.""" + description: Optional[str] = rest_field() + """Procedure description.""" + + @overload + def __init__( + self, + *, + extension: Optional[List["_models.Extension"]] = None, + code: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientDetails(_model_base.Model): + """Patient structured information, including demographics and known structured clinical + information. + + :ivar sex: The patient's sex. Known values are: "female", "male", and "unspecified". + :vartype sex: str or ~azure.healthinsights.radiologyinsights.models.PatientSex + :ivar birth_date: The patient's date of birth. + :vartype birth_date: ~datetime.date + :ivar clinical_info: Known clinical information for the patient, structured. + :vartype clinical_info: list[~azure.healthinsights.radiologyinsights.models.Resource] + """ + + sex: Optional[Union[str, "_models.PatientSex"]] = rest_field() + """The patient's sex. Known values are: \"female\", \"male\", and \"unspecified\".""" + birth_date: Optional[datetime.date] = rest_field(name="birthDate") + """The patient's date of birth.""" + clinical_info: Optional[List["_models.Resource"]] = rest_field(name="clinicalInfo") + """Known clinical information for the patient, structured.""" + + @overload + def __init__( + self, + *, + sex: Optional[Union[str, "_models.PatientSex"]] = None, + birth_date: Optional[datetime.date] = None, + clinical_info: Optional[List["_models.Resource"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientDocument(_model_base.Model): + """A clinical document related to a patient. Document here is in the wide sense - not just a text + document (note). + + All required parameters must be populated in order to send to server. + + :ivar type: The type of the patient document, such as 'note' (text document) or 'fhirBundle' + (FHIR JSON document). Required. Known values are: "note", "fhirBundle", "dicom", and + "genomicSequencing". + :vartype type: str or ~azure.healthinsights.radiologyinsights.models.DocumentType + :ivar clinical_type: The type of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", "procedure", "progress", + "laboratory", and "pathologyReport". + :vartype clinical_type: str or + ~azure.healthinsights.radiologyinsights.models.ClinicalDocumentType + :ivar id: A given identifier for the document. Has to be unique across all documents for a + single patient. Required. + :vartype id: str + :ivar language: A 2 letter ISO 639-1 representation of the language of the document. + :vartype language: str + :ivar created_date_time: The date and time when the document was created. + :vartype created_date_time: ~datetime.datetime + :ivar authors: Document author(s). + :vartype authors: list[~azure.healthinsights.radiologyinsights.models.DocumentAuthor] + :ivar specialty_type: specialty type the document. Known values are: "pathology" and + "radiology". + :vartype specialty_type: str or ~azure.healthinsights.radiologyinsights.models.SpecialtyType + :ivar administrative_metadata: Administrative metadata for the document. + :vartype administrative_metadata: + ~azure.healthinsights.radiologyinsights.models.DocumentAdministrativeMetadata + :ivar content: The content of the patient document. Required. + :vartype content: ~azure.healthinsights.radiologyinsights.models.DocumentContent + """ + + type: Union[str, "_models.DocumentType"] = rest_field() + """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON + document). Required. Known values are: \"note\", \"fhirBundle\", \"dicom\", and + \"genomicSequencing\".""" + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = rest_field(name="clinicalType") + """The type of the clinical document. Known values are: \"consultation\", \"dischargeSummary\", + \"historyAndPhysical\", \"radiologyReport\", \"procedure\", \"progress\", \"laboratory\", and + \"pathologyReport\".""" + id: str = rest_field() + """A given identifier for the document. Has to be unique across all documents for a single + patient. Required.""" + language: Optional[str] = rest_field() + """A 2 letter ISO 639-1 representation of the language of the document.""" + created_date_time: Optional[datetime.datetime] = rest_field(name="createdDateTime", format="rfc3339") + """The date and time when the document was created.""" + authors: Optional[List["_models.DocumentAuthor"]] = rest_field() + """Document author(s).""" + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = rest_field(name="specialtyType") + """specialty type the document. Known values are: \"pathology\" and \"radiology\".""" + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = rest_field( + name="administrativeMetadata" + ) + """Administrative metadata for the document.""" + content: "_models.DocumentContent" = rest_field() + """The content of the patient document. Required.""" + + @overload + def __init__( + self, + *, + type: Union[str, "_models.DocumentType"], + id: str, # pylint: disable=redefined-builtin + content: "_models.DocumentContent", + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = None, + language: Optional[str] = None, + created_date_time: Optional[datetime.datetime] = None, + authors: Optional[List["_models.DocumentAuthor"]] = None, + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = None, + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientRecord(_model_base.Model): + """A patient record, including their clinical information and data. + + All required parameters must be populated in order to send to server. + + :ivar id: A given identifier for the patient. Has to be unique across all patients in a single + request. Required. + :vartype id: str + :ivar info: Patient structured information, including demographics and known structured + clinical information. + :vartype info: ~azure.healthinsights.radiologyinsights.models.PatientDetails + :ivar encounters: Patient encounters/visits. + :vartype encounters: list[~azure.healthinsights.radiologyinsights.models.Encounter] + :ivar patient_documents: Patient unstructured clinical data, given as documents. + :vartype patient_documents: + list[~azure.healthinsights.radiologyinsights.models.PatientDocument] + """ + + id: str = rest_field() + """A given identifier for the patient. Has to be unique across all patients in a single request. + Required.""" + info: Optional["_models.PatientDetails"] = rest_field() + """Patient structured information, including demographics and known structured clinical + information.""" + encounters: Optional[List["_models.Encounter"]] = rest_field() + """Patient encounters/visits.""" + patient_documents: Optional[List["_models.PatientDocument"]] = rest_field(name="patientDocuments") + """Patient unstructured clinical data, given as documents.""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + info: Optional["_models.PatientDetails"] = None, + encounters: Optional[List["_models.Encounter"]] = None, + patient_documents: Optional[List["_models.PatientDocument"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Period(Element): + """A time period defined by a start and end date and optionally time + Based on `FHIR Period `_. + + :ivar start: Starting time with inclusive boundary. + :vartype start: str + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: str + """ + + start: Optional[str] = rest_field() + """Starting time with inclusive boundary.""" + end: Optional[str] = rest_field() + """End time with inclusive boundary, if not ongoing.""" + + @overload + def __init__( + self, + *, + start: Optional[str] = None, + end: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Quantity(Element): + """A measured or measurable amount + Based on `FHIR Quantity `_. + + :ivar value: Numerical value (with implicit precision). + :vartype value: float + :ivar comparator: < | <= | >= | > - how to understand the value. + :vartype comparator: str + :ivar unit: Unit representation. + :vartype unit: str + :ivar system: System that defines coded unit form. + :vartype system: str + :ivar code: Coded form of the unit. + :vartype code: str + """ + + value: Optional[float] = rest_field() + """Numerical value (with implicit precision).""" + comparator: Optional[str] = rest_field() + """< | <= | >= | > - how to understand the value.""" + unit: Optional[str] = rest_field() + """Unit representation.""" + system: Optional[str] = rest_field() + """System that defines coded unit form.""" + code: Optional[str] = rest_field() + """Coded form of the unit.""" + + @overload + def __init__( + self, + *, + value: Optional[float] = None, + comparator: Optional[str] = None, + unit: Optional[str] = None, + system: Optional[str] = None, + code: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyCodeWithTypes(_model_base.Model): + """Radiology code with types : used in imaging procedure recommendation for contrast and view. + + All required parameters must be populated in order to send to server. + + :ivar code: The SNOMED CT code indicates whether imaging was conducted with or without contrast + in the case of contrast, and in the case of views, it denotes the number of views. Required. + :vartype code: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar types: The collection of types will indicate the contrast substance used in the case of + contrast and, in the case of views, it will specify the types of views, such as lateral and + frontal, etc. Required. + :vartype types: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + """ + + code: "_models.CodeableConcept" = rest_field() + """The SNOMED CT code indicates whether imaging was conducted with or without contrast in the case + of contrast, and in the case of views, it denotes the number of views. Required.""" + types: List["_models.CodeableConcept"] = rest_field() + """The collection of types will indicate the contrast substance used in the case of contrast and, + in the case of views, it will specify the types of views, such as lateral and frontal, etc. + Required.""" + + @overload + def __init__( + self, + *, + code: "_models.CodeableConcept", + types: List["_models.CodeableConcept"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyInsightsData(_model_base.Model): + """Contains the list of patients, and configuration data. + + All required parameters must be populated in order to send to server. + + :ivar patients: The list of patients, including their clinical information and data. Required. + :vartype patients: list[~azure.healthinsights.radiologyinsights.models.PatientRecord] + :ivar configuration: Configuration affecting the Radiology Insights model's inference. + :vartype configuration: + ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsModelConfiguration + """ + + patients: List["_models.PatientRecord"] = rest_field() + """The list of patients, including their clinical information and data. Required.""" + configuration: Optional["_models.RadiologyInsightsModelConfiguration"] = rest_field() + """Configuration affecting the Radiology Insights model's inference.""" + + @overload + def __init__( + self, + *, + patients: List["_models.PatientRecord"], + configuration: Optional["_models.RadiologyInsightsModelConfiguration"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyInsightsInferenceOptions(_model_base.Model): + """Options regarding follow up recommendation inferences and finding inferences. + + :ivar followup_recommendation_options: Follow-up recommendation options. + :vartype followup_recommendation_options: + ~azure.healthinsights.radiologyinsights.models.FollowupRecommendationOptions + :ivar finding_options: Finding options. + :vartype finding_options: ~azure.healthinsights.radiologyinsights.models.FindingOptions + """ + + followup_recommendation_options: Optional["_models.FollowupRecommendationOptions"] = rest_field( + name="followupRecommendationOptions" + ) + """Follow-up recommendation options.""" + finding_options: Optional["_models.FindingOptions"] = rest_field(name="findingOptions") + """Finding options.""" + + @overload + def __init__( + self, + *, + followup_recommendation_options: Optional["_models.FollowupRecommendationOptions"] = None, + finding_options: Optional["_models.FindingOptions"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyInsightsInferenceResult(_model_base.Model): + """The inference results for the Radiology Insights request. If field 'status' has value + 'succeeded', then field 'result' will contain an instance of RadiologyInsightsInferenceResult. + + All required parameters must be populated in order to send to server. + + :ivar patient_results: Results for the patients given in the request. Required. + :vartype patient_results: + list[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsPatientResult] + :ivar model_version: The version of the model used for inference, expressed as the model date. + Required. + :vartype model_version: str + """ + + patient_results: List["_models.RadiologyInsightsPatientResult"] = rest_field(name="patientResults") + """Results for the patients given in the request. Required.""" + model_version: str = rest_field(name="modelVersion") + """The version of the model used for inference, expressed as the model date. Required.""" + + @overload + def __init__( + self, + *, + patient_results: List["_models.RadiologyInsightsPatientResult"], + model_version: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyInsightsModelConfiguration(_model_base.Model): + """Configuration affecting the Radiology Insights model's inference. + + :ivar verbose: An indication whether the model should produce verbose output. + :vartype verbose: bool + :ivar include_evidence: An indication whether the model's output should include evidence for + the inferences. + :vartype include_evidence: bool + :ivar inference_types: This is a list of inference types to be inferred for the current + request. It could be used if only part of the Radiology Insights inferences are required. If + this list is omitted or empty, the model will return all the inference types. + :vartype inference_types: list[str or + ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceType] + :ivar inference_options: Options regarding follow up recommendation inferences and finding + inferences. + :vartype inference_options: + ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceOptions + :ivar locale: Local for the model to use. If not specified, the model will use the default + locale. + :vartype locale: str + """ + + verbose: Optional[bool] = rest_field() + """An indication whether the model should produce verbose output.""" + include_evidence: Optional[bool] = rest_field(name="includeEvidence") + """An indication whether the model's output should include evidence for the inferences.""" + inference_types: Optional[List[Union[str, "_models.RadiologyInsightsInferenceType"]]] = rest_field( + name="inferenceTypes" + ) + """This is a list of inference types to be inferred for the current request. It could be used if + only part of the Radiology Insights inferences are required. If this list is omitted or empty, + the model will return all the inference types.""" + inference_options: Optional["_models.RadiologyInsightsInferenceOptions"] = rest_field(name="inferenceOptions") + """Options regarding follow up recommendation inferences and finding inferences.""" + locale: Optional[str] = rest_field() + """Local for the model to use. If not specified, the model will use the default locale.""" + + @overload + def __init__( + self, + *, + verbose: Optional[bool] = None, + include_evidence: Optional[bool] = None, + inference_types: Optional[List[Union[str, "_models.RadiologyInsightsInferenceType"]]] = None, + inference_options: Optional["_models.RadiologyInsightsInferenceOptions"] = None, + locale: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyInsightsPatientResult(_model_base.Model): + """Results of the model's work for a single patient. + + All required parameters must be populated in order to send to server. + + :ivar patient_id: Identifier given for the patient in the request. Required. + :vartype patient_id: str + :ivar inferences: The model's inferences for the given patient. Required. + :vartype inferences: + list[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInference] + """ + + patient_id: str = rest_field(name="patientId") + """Identifier given for the patient in the request. Required.""" + inferences: List["_models.RadiologyInsightsInference"] = rest_field() + """The model's inferences for the given patient. Required.""" + + @overload + def __init__( + self, + *, + patient_id: str, + inferences: List["_models.RadiologyInsightsInference"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyProcedureInference(RadiologyInsightsInference, discriminator="radiologyProcedure"): + """Radiology procedures are the specific imaging studies or examinations ordered for the patient, + extracted from the document information and text. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Radiology Procedure inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.RADIOLOGY_PROCEDURE + :ivar procedure_codes: LOINC codes for the procedure. + :vartype procedure_codes: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar imaging_procedures: Imaging procedures. Required. + :vartype imaging_procedures: + list[~azure.healthinsights.radiologyinsights.models.ImagingProcedure] + :ivar ordered_procedure: Ordered procedure information from the document information or text. + Required. + :vartype ordered_procedure: ~azure.healthinsights.radiologyinsights.models.OrderedProcedure + """ + + kind: Literal[RadiologyInsightsInferenceType.RADIOLOGY_PROCEDURE] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Radiology Procedure inference type""" + procedure_codes: Optional[List["_models.CodeableConcept"]] = rest_field(name="procedureCodes") + """LOINC codes for the procedure.""" + imaging_procedures: List["_models.ImagingProcedure"] = rest_field(name="imagingProcedures") + """Imaging procedures. Required.""" + ordered_procedure: "_models.OrderedProcedure" = rest_field(name="orderedProcedure") + """Ordered procedure information from the document information or text. Required.""" + + @overload + def __init__( + self, + *, + imaging_procedures: List["_models.ImagingProcedure"], + ordered_procedure: "_models.OrderedProcedure", + extension: Optional[List["_models.Extension"]] = None, + procedure_codes: Optional[List["_models.CodeableConcept"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal[ + RadiologyInsightsInferenceType.RADIOLOGY_PROCEDURE + ] = RadiologyInsightsInferenceType.RADIOLOGY_PROCEDURE + + +class Range(Element): + """A set of ordered Quantities defined by a low and high limit + Based on `FHIR Range `_. + + :ivar low: Low limit. + :vartype low: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar high: High limit. + :vartype high: ~azure.healthinsights.radiologyinsights.models.Quantity + """ + + low: Optional["_models.Quantity"] = rest_field() + """Low limit.""" + high: Optional["_models.Quantity"] = rest_field() + """High limit.""" + + @overload + def __init__( + self, + *, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Ratio(Element): + """A ratio of two Quantity values - a numerator and a denominator + Based on `FHIR Ratio `_. + + :ivar numerator: Numerator value. + :vartype numerator: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar denominator: Denominator value. + :vartype denominator: ~azure.healthinsights.radiologyinsights.models.Quantity + """ + + numerator: Optional["_models.Quantity"] = rest_field() + """Numerator value.""" + denominator: Optional["_models.Quantity"] = rest_field() + """Denominator value.""" + + @overload + def __init__( + self, + *, + numerator: Optional["_models.Quantity"] = None, + denominator: Optional["_models.Quantity"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RecommendationFinding(_model_base.Model): + """Finding reference for recommendation. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar finding: Finding linked to a recommendation. + :vartype finding: ~azure.healthinsights.radiologyinsights.models.Observation + :ivar critical_finding: Critical result linked to a recommendation. + :vartype critical_finding: ~azure.healthinsights.radiologyinsights.models.CriticalResult + :ivar recommendation_finding_status: Recommendation finding status. Required. Known values are: + "present", "differential", "ruleOut", and "conditional". + :vartype recommendation_finding_status: str or + ~azure.healthinsights.radiologyinsights.models.RecommendationFindingStatusType + """ + + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + finding: Optional["_models.Observation"] = rest_field() + """Finding linked to a recommendation.""" + critical_finding: Optional["_models.CriticalResult"] = rest_field(name="criticalFinding") + """Critical result linked to a recommendation.""" + recommendation_finding_status: Union[str, "_models.RecommendationFindingStatusType"] = rest_field( + name="recommendationFindingStatus" + ) + """Recommendation finding status. Required. Known values are: \"present\", \"differential\", + \"ruleOut\", and \"conditional\".""" + + @overload + def __init__( + self, + *, + recommendation_finding_status: Union[str, "_models.RecommendationFindingStatusType"], + extension: Optional[List["_models.Extension"]] = None, + finding: Optional["_models.Observation"] = None, + critical_finding: Optional["_models.CriticalResult"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Reference(Element): + """A reference from one resource to another + Based on `FHIR Reference `_. + + :ivar reference: Literal reference, Relative, internal or absolute URL. + :vartype reference: str + :ivar type: Type the reference refers to (e.g. "Patient"). + :vartype type: str + :ivar identifier: Logical reference, when literal reference is not known. + :vartype identifier: ~azure.healthinsights.radiologyinsights.models.Identifier + :ivar display: Text alternative for the resource. + :vartype display: str + """ + + reference: Optional[str] = rest_field() + """Literal reference, Relative, internal or absolute URL.""" + type: Optional[str] = rest_field() + """Type the reference refers to (e.g. \"Patient\").""" + identifier: Optional["_models.Identifier"] = rest_field() + """Logical reference, when literal reference is not known.""" + display: Optional[str] = rest_field() + """Text alternative for the resource.""" + + @overload + def __init__( + self, + *, + reference: Optional[str] = None, + type: Optional[str] = None, + identifier: Optional["_models.Identifier"] = None, + display: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResearchStudy(DomainResource, discriminator="ResearchStudy"): # pylint: disable=too-many-instance-attributes + """Detailed information about Research Study + Based on `FHIR ResearchStudy `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.radiologyinsights.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.radiologyinsights.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.radiologyinsights.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "ResearchStudy". + :vartype resource_type: str + :ivar identifier: Business Identifier for study. + :vartype identifier: list[~azure.healthinsights.radiologyinsights.models.Identifier] + :ivar title: Name for this study. + :vartype title: str + :ivar protocol: Steps followed in executing study. + :vartype protocol: list[~azure.healthinsights.radiologyinsights.models.Reference] + :ivar part_of: Part of larger study. + :vartype part_of: list[~azure.healthinsights.radiologyinsights.models.Reference] + :ivar status: active | administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | in-review | + temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", "administratively-completed", "approved", + "closed-to-accrual", "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", "temporarily-closed-to-accrual-and-intervention", + and "withdrawn". + :vartype status: str or + ~azure.healthinsights.radiologyinsights.models.ResearchStudyStatusCodeType + :ivar primary_purpose_type: treatment | prevention | diagnostic | supportive-care | screening | + health-services-research | basic-science | device-feasibility. + :vartype primary_purpose_type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar phase: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | + phase-3 | phase-4. + :vartype phase: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar category: Classifications for the study. + :vartype category: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar focus: Drugs, devices, etc. under study. + :vartype focus: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar condition: Condition being studied. + :vartype condition: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar contact: Contact details for the study. + :vartype contact: list[~azure.healthinsights.radiologyinsights.models.ContactDetail] + :ivar keyword: Used to search for the study. + :vartype keyword: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar location: Geographic region(s) for study. + :vartype location: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar description: What this is study doing. + :vartype description: str + :ivar enrollment: Inclusion & exclusion criteria. + :vartype enrollment: list[~azure.healthinsights.radiologyinsights.models.Reference] + :ivar period: When the study began and ended. + :vartype period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar sponsor: Organization that initiates and is legally responsible for the study. + :vartype sponsor: ~azure.healthinsights.radiologyinsights.models.Reference + :ivar principal_investigator: Researcher who oversees multiple aspects of the study. + :vartype principal_investigator: ~azure.healthinsights.radiologyinsights.models.Reference + :ivar site: Facility where study activities are conducted. + :vartype site: list[~azure.healthinsights.radiologyinsights.models.Reference] + :ivar reason_stopped: accrual-goal-met | closed-due-to-toxicity | + closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design. + :vartype reason_stopped: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar note: Comments made about the study. + :vartype note: list[~azure.healthinsights.radiologyinsights.models.Annotation] + :ivar arm: Defined path through the study for a subject. + :vartype arm: list[~azure.healthinsights.radiologyinsights.models.ResearchStudyArm] + :ivar objective: A goal for the study. + :vartype objective: list[~azure.healthinsights.radiologyinsights.models.ResearchStudyObjective] + """ + + resource_type: Literal["ResearchStudy"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"ResearchStudy\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """Business Identifier for study.""" + title: Optional[str] = rest_field() + """Name for this study.""" + protocol: Optional[List["_models.Reference"]] = rest_field() + """Steps followed in executing study.""" + part_of: Optional[List["_models.Reference"]] = rest_field(name="partOf") + """Part of larger study.""" + status: Union[str, "_models.ResearchStudyStatusCodeType"] = rest_field() + """active | administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | in-review | + temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: \"active\", \"administratively-completed\", \"approved\", + \"closed-to-accrual\", \"closed-to-accrual-and-intervention\", \"completed\", \"disapproved\", + \"in-review\", \"temporarily-closed-to-accrual\", + \"temporarily-closed-to-accrual-and-intervention\", and \"withdrawn\".""" + primary_purpose_type: Optional["_models.CodeableConcept"] = rest_field(name="primaryPurposeType") + """treatment | prevention | diagnostic | supportive-care | screening | health-services-research | + basic-science | device-feasibility.""" + phase: Optional["_models.CodeableConcept"] = rest_field() + """n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | + phase-4.""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """Classifications for the study.""" + focus: Optional[List["_models.CodeableConcept"]] = rest_field() + """Drugs, devices, etc. under study.""" + condition: Optional[List["_models.CodeableConcept"]] = rest_field() + """Condition being studied.""" + contact: Optional[List["_models.ContactDetail"]] = rest_field() + """Contact details for the study.""" + keyword: Optional[List["_models.CodeableConcept"]] = rest_field() + """Used to search for the study.""" + location: Optional[List["_models.CodeableConcept"]] = rest_field() + """Geographic region(s) for study.""" + description: Optional[str] = rest_field() + """What this is study doing.""" + enrollment: Optional[List["_models.Reference"]] = rest_field() + """Inclusion & exclusion criteria.""" + period: Optional["_models.Period"] = rest_field() + """When the study began and ended.""" + sponsor: Optional["_models.Reference"] = rest_field() + """Organization that initiates and is legally responsible for the study.""" + principal_investigator: Optional["_models.Reference"] = rest_field(name="principalInvestigator") + """Researcher who oversees multiple aspects of the study.""" + site: Optional[List["_models.Reference"]] = rest_field() + """Facility where study activities are conducted.""" + reason_stopped: Optional["_models.CodeableConcept"] = rest_field(name="reasonStopped") + """accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | + temporarily-closed-per-study-design.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Comments made about the study.""" + arm: Optional[List["_models.ResearchStudyArm"]] = rest_field() + """Defined path through the study for a subject.""" + objective: Optional[List["_models.ResearchStudyObjective"]] = rest_field() + """A goal for the study.""" + + @overload + def __init__( + self, + *, + status: Union[str, "_models.ResearchStudyStatusCodeType"], + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + title: Optional[str] = None, + protocol: Optional[List["_models.Reference"]] = None, + part_of: Optional[List["_models.Reference"]] = None, + primary_purpose_type: Optional["_models.CodeableConcept"] = None, + phase: Optional["_models.CodeableConcept"] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + focus: Optional[List["_models.CodeableConcept"]] = None, + condition: Optional[List["_models.CodeableConcept"]] = None, + contact: Optional[List["_models.ContactDetail"]] = None, + keyword: Optional[List["_models.CodeableConcept"]] = None, + location: Optional[List["_models.CodeableConcept"]] = None, + description: Optional[str] = None, + enrollment: Optional[List["_models.Reference"]] = None, + period: Optional["_models.Period"] = None, + sponsor: Optional["_models.Reference"] = None, + principal_investigator: Optional["_models.Reference"] = None, + site: Optional[List["_models.Reference"]] = None, + reason_stopped: Optional["_models.CodeableConcept"] = None, + note: Optional[List["_models.Annotation"]] = None, + arm: Optional[List["_models.ResearchStudyArm"]] = None, + objective: Optional[List["_models.ResearchStudyObjective"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.resource_type: Literal["ResearchStudy"] = "ResearchStudy" + + +class ResearchStudyArm(_model_base.Model): + """ResearchStudyArm. + + All required parameters must be populated in order to send to server. + + :ivar name: Label for study arm. Required. + :vartype name: str + :ivar type: Categorization of study arm. + :vartype type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar description: Short explanation of study path. + :vartype description: str + """ + + name: str = rest_field() + """Label for study arm. Required.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Categorization of study arm.""" + description: Optional[str] = rest_field() + """Short explanation of study path.""" + + @overload + def __init__( + self, + *, + name: str, + type: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResearchStudyObjective(_model_base.Model): + """ResearchStudyObjective. + + All required parameters must be populated in order to send to server. + + :ivar name: Label for the objective. Required. + :vartype name: str + :ivar type: primary | secondary | exploratory. + :vartype type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + """ + + name: str = rest_field() + """Label for the objective. Required.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """primary | secondary | exploratory.""" + + @overload + def __init__( + self, + *, + name: str, + type: Optional["_models.CodeableConcept"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SampledData(Element): + """A series of measurements taken by a device + Based on `FHIR SampledData `_. + + All required parameters must be populated in order to send to server. + + :ivar origin: Zero value and units. Required. + :vartype origin: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar period: Number of milliseconds between samples. Required. + :vartype period: float + :ivar factor: Multiply data by this before adding to origin. + :vartype factor: float + :ivar lower_limit: Lower limit of detection. + :vartype lower_limit: float + :ivar upper_limit: Upper limit of detection. + :vartype upper_limit: float + :ivar dimensions: Number of sample points at each time point. Required. + :vartype dimensions: int + :ivar data: Decimal values with spaces, or "E" | "U" | "L". + :vartype data: str + """ + + origin: "_models.Quantity" = rest_field() + """Zero value and units. Required.""" + period: float = rest_field() + """Number of milliseconds between samples. Required.""" + factor: Optional[float] = rest_field() + """Multiply data by this before adding to origin.""" + lower_limit: Optional[float] = rest_field(name="lowerLimit") + """Lower limit of detection.""" + upper_limit: Optional[float] = rest_field(name="upperLimit") + """Upper limit of detection.""" + dimensions: int = rest_field() + """Number of sample points at each time point. Required.""" + data: Optional[str] = rest_field() + """Decimal values with spaces, or \"E\" | \"U\" | \"L\".""" + + @overload + def __init__( + self, + *, + origin: "_models.Quantity", + period: float, + dimensions: int, + factor: Optional[float] = None, + lower_limit: Optional[float] = None, + upper_limit: Optional[float] = None, + data: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SexMismatchInference(RadiologyInsightsInference, discriminator="sexMismatch"): + """A notification for a sex mismatch is displayed when the gender, personal pronouns, + gender-related body parts, or gender-related procedures mentioned in a patient's clinical + document are either inconsistent or do not match the gender specified in the patient + information. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Sex mismatch inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.SEX_MISMATCH + :ivar sex_indication: Sex indication : SNOMED CT code for gender finding. Required. + :vartype sex_indication: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + """ + + kind: Literal[RadiologyInsightsInferenceType.SEX_MISMATCH] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Sex mismatch inference type""" + sex_indication: "_models.CodeableConcept" = rest_field(name="sexIndication") + """Sex indication : SNOMED CT code for gender finding. Required.""" + + @overload + def __init__( + self, + *, + sex_indication: "_models.CodeableConcept", + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind: Literal[RadiologyInsightsInferenceType.SEX_MISMATCH] = RadiologyInsightsInferenceType.SEX_MISMATCH + + +class TimePeriod(_model_base.Model): + """A duration of time during which an event is happening. + + :ivar start: Starting time with inclusive boundary. + :vartype start: ~datetime.datetime + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: ~datetime.datetime + """ + + start: Optional[datetime.datetime] = rest_field(format="rfc3339") + """Starting time with inclusive boundary.""" + end: Optional[datetime.datetime] = rest_field(format="rfc3339") + """End time with inclusive boundary, if not ongoing.""" + + @overload + def __init__( + self, + *, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_patch.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/py.typed b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/py.typed new file mode 100644 index 0000000000000..e5aff4f83af86 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/dev_requirements.txt b/sdk/healthinsights/azure-healthinsights-radiologyinsights/dev_requirements.txt new file mode 100644 index 0000000000000..ff12ab35dd010 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/dev_requirements.txt @@ -0,0 +1,4 @@ +-e ../../../tools/azure-devtools +-e ../../../tools/azure-sdk-tools +../../core/azure-core +aiohttp \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/sdk_packaging.toml b/sdk/healthinsights/azure-healthinsights-radiologyinsights/sdk_packaging.toml new file mode 100644 index 0000000000000..e7687fdae93bc --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/sdk_packaging.toml @@ -0,0 +1,2 @@ +[packaging] +auto_update = false \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/setup.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/setup.py new file mode 100644 index 0000000000000..fc2f920f566fc --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/setup.py @@ -0,0 +1,70 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# coding: utf-8 + +import os +import re +from setuptools import setup, find_packages + + +PACKAGE_NAME = "azure-healthinsights-radiologyinsights" +PACKAGE_PPRINT_NAME = "Azure Health Insights - Radiology Insights" + +# a-b-c => a/b/c +package_folder_path = PACKAGE_NAME.replace("-", "/") + +# Version extraction inspired from 'requests' +with open(os.path.join(package_folder_path, "_version.py"), "r") as fd: + version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) + +if not version: + raise RuntimeError("Cannot find version information") + + +setup( + name=PACKAGE_NAME, + version=version, + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), + long_description=open("README.md", "r").read(), + long_description_content_type="text/markdown", + license="MIT License", + author="Microsoft Corporation", + author_email="azpysdkhelp@microsoft.com", + url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", + keywords="azure, azure sdk", + classifiers=[ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "License :: OSI Approved :: MIT License", + ], + zip_safe=False, + packages=find_packages( + exclude=[ + "tests", + # Exclude packages that will be covered by PEP420 or nspkg + "azure", + "azure.healthinsights", + ] + ), + include_package_data=True, + package_data={ + "azure.healthinsights.radiologyinsights": ["py.typed"], + }, + install_requires=[ + "isodate<1.0.0,>=0.6.1", + "azure-core<2.0.0,>=1.29.5", + ], + python_requires=">=3.8", +) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/tsp-location.yaml b/sdk/healthinsights/azure-healthinsights-radiologyinsights/tsp-location.yaml new file mode 100644 index 0000000000000..5d9fd5c8d47a9 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/tsp-location.yaml @@ -0,0 +1,7 @@ +directory: specification/ai/HealthInsights/HealthInsights.RadiologyInsights +additionalDirectories: +- specification/ai/HealthInsights/HealthInsights.Common/ +- specification/ai/HealthInsights/HealthInsights.OpenAPI/ +repo: Azure/azure-rest-api-specs +commit: f3dcae0fb8ccf9267fa0c8eb32f52125c58cd0fd + diff --git a/sdk/healthinsights/ci.yml b/sdk/healthinsights/ci.yml index f59f6e7bf0d88..1029a03eddf3b 100644 --- a/sdk/healthinsights/ci.yml +++ b/sdk/healthinsights/ci.yml @@ -37,3 +37,7 @@ extends: - name: azure-healthinsights-clinicalmatching safeName: azurehealthinsightsclinicalmatching skipVerifyChangeLog: true + - name: azure-healthinsights-patienttimeline + safeName: azurehealthinsightspatienttimeline + - name: azure-healthinsights-radiologyinsights + safeName: azurehealthinsightsradiologyinsights