The CData Sync App provides a straightforward way to continuously pipeline your FHIR data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The FHIR connector can be used from the CData Sync application to pull data from FHIR and move it to any of the supported destinations.
The Sync App leverages the FHIR standard to enable access to FHIR resources across Azure, Amazon, Google, and generic implementations of FHIR servers.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
Set Url to the Service Base URL of the FHIR server. This is the address where the resources are defined in the FHIR server you would like to connect to.
Generic, Azure-based, AWS-based, and Google-based FHIR server implementations are supported.
Sample Urls for each implementation are found below:
The Sync App supports connections to custom instances of FHIR.
Authentication to custom FHIR servers is handled via OAuth.
Before you can connect to custom FHIR instances, you must set ConnectionType to Generic.
Set the AuthScheme to OAuth.
OAuth requires the authenticating user to interact with FHIR using the browser. The Sync App facilitates this in various ways as described in the following sections.
Before following the procedures below, you need to register an OAuth app with the service to obtain OAuthClientId and OAuthClientSecret.
The Sync App supports connections to instances of FHIR hosted on Microsoft Azure.
You can authenticate with Azure Active Directory, an Azure Service Principal, or Azure MSI.
Before you can connect to FHIR instances hosted on Azure, you must set ConnectionType to Azure.
Set AuthScheme to AzureAD.
Embedded App
CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. To authenticate using the embedded OAuth app, connect without setting any additional connection properties.
Custom App
Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.
Once your OAuth app has been created, set the following to connect:
If you are running FHIR on an Azure VM, set AuthScheme to AzureMSI to authenticate using Managed Service Identity (MSI) credentials.
The MSI credentials will then be automatically obtained for authentication.
You can authenticate to Azure-hosted instances of FHIR using an Azure service principal.
See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.
Once your OAuth app has been created, set the following to connect:
The Sync App supports connections to instances of FHIR hosted on AWS.
You can authenticate with AWS Root Keys, AWS EC2 Roles, or AWS IAM Roles.
Before you can connect to FHIR instances hosted on AWS, you must set ConnectionType to AWS.
You can authenticate using the access keys for the root AWS user. Set the following:
To authenticate to your AWS-hosted FHIR using IAM roles, set the following:
If you are using the Sync App from an EC2 Instance and have an IAM Role assigned to the instance, you can use the IAM role to authenticate.
Set AuthScheme to AwsEC2Roles.
If you are also using an IAM role to authenticate, you must additionally set AWSRoleARN to the Role ARN for the role you'd like to authenticate with. This will cause the Sync App to attempt to retrieve credentials for the specified role.
The Sync App supports connections to instances of FHIR hosted on Google Cloud Platform.
You can authenticate with standard OAuth or Service account authentication (with a JWT).
Before you can connect to FHIR instances hosted on Google Cloud Platform, you must set ConnectionType to Google.
Set AuthScheme to OAuth.
Embedded App
CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. To authenticate using the embedded OAuth app, connect without setting any additional connection properties.
Custom App
Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.
Unlike the Generic connection type, when ConnectionType is set to Google, OAuthAuthorizationURL, OAuthRefreshTokenURL, and OAuthAccessTokenURL are not required to be set.
This is because, when connecting to an instance of FHIR hosted on Google Cloud Platform, these properties have default values embedded in the Sync App.
Aside from omitting those properties, follow the same procedures for configuring OAuth authentication as with generic implementations of FHIR (see the "OAuth" section under the "Generic FHIR Instances" section above).
To authenticate using a service account, you must create a new service account and have a copy of the accounts certificate.
If you would like to use a JSON file as the certificate, you need to set these properties:
If you would like to use a PFX file as the certificate, you need to set these properties instead:
The Sync App dynamically models resources from your FHIR instance as tables.
This documentation describes a "best-case" where the FHIR provider's implementation has been developed in strict accordance with the FHIR standard.
FHIR does not enforce that every table, column, search parameter, or implementation of server-side processing is present in any given FHIR implementation. As a result, some of the information documented here may differ from your FHIR implementation.
Views describes the available views. Views are dynamically discovered from the FHIR instance specified in the Url connection property.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Name | Description |
Account | Account view. |
ActivityDefinition | ActivityDefinition view. |
AdministrableProductDefinition | AdministrableProductDefinition view. |
AdverseEvent | AdverseEvent view. |
AllergyIntolerance | AllergyIntolerance view. |
Appointment | Appointment view. |
AppointmentResponse | AppointmentResponse view. |
AuditEvent | AuditEvent view. |
BiologicallyDerivedProduct | BiologicallyDerivedProduct view. |
BodyStructure | BodyStructure view. |
CarePlan | CarePlan view. |
CareTeam | CareTeam view. |
CatalogEntry | CatalogEntry view. |
ChargeItem | ChargeItem view. |
ChargeItemDefinition | ChargeItemDefinition view. |
Claim | Claim view. |
ClaimResponse | ClaimResponse view. |
ClinicalImpression | ClinicalImpression view. |
ClinicalUseDefinition | ClinicalUseDefinition view. |
Communication | Communication view. |
CommunicationRequest | CommunicationRequest view. |
Condition | Condition view. |
Contract | Contract view. |
Coverage | Coverage view. |
CoverageEligibilityRequest | CoverageEligibilityRequest view. |
CoverageEligibilityResponse | CoverageEligibilityResponse view. |
DetectedIssue | DetectedIssue view. |
Device | Device view. |
DeviceDefinition | DeviceDefinition view. |
DeviceMetric | DeviceMetric view. |
DeviceRequest | DeviceRequest view. |
DeviceUseStatement | DeviceUseStatement view. |
DiagnosticReport | DiagnosticReport view. |
Endpoint | Endpoint view. |
EnrollmentRequest | EnrollmentRequest view. |
EnrollmentResponse | EnrollmentResponse view. |
EventDefinition | EventDefinition view. |
Evidence | Evidence view. |
EvidenceReport | EvidenceReport view. |
EvidenceVariable | EvidenceVariable view. |
ExplanationOfBenefit | ExplanationOfBenefit view. |
FamilyMemberHistory | FamilyMemberHistory view. |
Flag | Flag view. |
Goal | Goal view. |
Group | Group view. |
GuidanceResponse | GuidanceResponse view. |
HealthcareService | HealthcareService view. |
ImagingStudy | ImagingStudy view. |
Immunization | Immunization view. |
ImmunizationEvaluation | ImmunizationEvaluation view. |
ImmunizationRecommendation | ImmunizationRecommendation view. |
Ingredient | Ingredient view. |
InsurancePlan | InsurancePlan view. |
Invoice | Invoice view. |
Library | Library view. |
List | List view. |
Location | Location view. |
Measure | Measure view. |
MeasureReport | MeasureReport view. |
Media | Media view. |
Medication | Medication view. |
MedicationAdministration | MedicationAdministration view. |
MedicationDispense | MedicationDispense view. |
MedicationKnowledge | MedicationKnowledge view. |
MedicationRequest | MedicationRequest view. |
MedicationStatement | MedicationStatement view. |
MedicinalProductDefinition | MedicinalProductDefinition view. |
NutritionProduct | NutritionProduct view. |
Observation | Observation view. |
ObservationDefinition | ObservationDefinition view. |
Organization | Organization view. |
OrganizationAffiliation | OrganizationAffiliation view. |
PackagedProductDefinition | PackagedProductDefinition view. |
Patient | Patient view. |
PaymentNotice | PaymentNotice view. |
PaymentReconciliation | PaymentReconciliation view. |
Person | Person view. |
PlanDefinition | PlanDefinition view. |
Practitioner | Practitioner view. |
PractitionerRole | PractitionerRole view. |
Procedure | Procedure view. |
Questionnaire | Questionnaire view. |
QuestionnaireResponse | QuestionnaireResponse view. |
RegulatedAuthorization | RegulatedAuthorization view. |
RelatedPerson | RelatedPerson view. |
RequestGroup | RequestGroup view. |
ResearchDefinition | ResearchDefinition view. |
ResearchElementDefinition | ResearchElementDefinition view. |
ResearchStudy | ResearchStudy view. |
ResearchSubject | ResearchSubject view. |
RiskAssessment | RiskAssessment view. |
Schedule | Schedule view. |
ServiceRequest | ServiceRequest view. |
Slot | Slot view. |
Specimen | Specimen view. |
SpecimenDefinition | SpecimenDefinition view. |
SubscriptionStatus | SubscriptionStatus view. |
SubscriptionTopic | SubscriptionTopic view. |
Substance | Substance view. |
SubstanceDefinition | SubstanceDefinition view. |
SupplyDelivery | SupplyDelivery view. |
SupplyRequest | SupplyRequest view. |
Task | Task view. |
TestReport | TestReport view. |
TestScript | TestScript view. |
VerificationResult | VerificationResult view. |
VisionPrescription | VisionPrescription view. |
Account view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number). |
identifier_use | String | The identifier-use of the identifier-use. Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number). |
identifier_type_coding | String | The coding of the identifier-type. Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number). |
identifier_type_text | String | The text of the identifier-type. Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number). |
identifier_system | String | The identifier-system of the identifier-system. Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number). |
identifier_period_start | String | The start of the identifier-period. Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number). |
identifier_period_end | String | The end of the identifier-period. Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number). |
status | String | Indicates whether the account is presently used/usable or not. |
type_coding | String | The coding of the type. Categorizes the account for reporting and searching purposes. |
type_text | String | The text of the type. Categorizes the account for reporting and searching purposes. |
name | String | Name used for the account when displaying it to humans in reports, etc. |
subject_display | String | The display of the subject. Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account. |
subject_reference | String | The reference of the subject. Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account. |
subject_identifier_value | String | The value of the subject-identifier. Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account. |
subject_type | String | The subject-type of the subject-type. Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account. |
servicePeriod_start | Datetime | The start of the servicePeriod. The date range of services associated with this account. |
servicePeriod_end | Datetime | The end of the servicePeriod. The date range of services associated with this account. |
coverage_id | String | The coverage-id of the coverage-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
coverage_extension | String | The coverage-extension of the coverage-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
coverage_modifierExtension | String | The coverage-modifierExtension of the coverage-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
coverage_coverage_display | String | The display of the coverage-coverage. The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay). A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing. |
coverage_coverage_reference | String | The reference of the coverage-coverage. The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay). A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing. |
coverage_coverage_identifier_value | String | The value of the coverage-coverage-identifier. The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay). A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing. |
coverage_coverage_type | String | The coverage-coverage-type of the coverage-coverage-type. The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay). A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing. |
coverage_priority | Int | The coverage-priority of the coverage-priority. The priority of the coverage in the context of this account. |
owner_display | String | The display of the owner. Indicates the service area, hospital, department, etc. with responsibility for managing the Account. |
owner_reference | String | The reference of the owner. Indicates the service area, hospital, department, etc. with responsibility for managing the Account. |
owner_identifier_value | String | The value of the owner-identifier. Indicates the service area, hospital, department, etc. with responsibility for managing the Account. |
owner_type | String | The owner-type of the owner-type. Indicates the service area, hospital, department, etc. with responsibility for managing the Account. |
description | String | Provides additional information about what the account tracks and how it is used. |
guarantor_id | String | The guarantor-id of the guarantor-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
guarantor_extension | String | The guarantor-extension of the guarantor-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
guarantor_modifierExtension | String | The guarantor-modifierExtension of the guarantor-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
guarantor_party_display | String | The display of the guarantor-party. The entity who is responsible. |
guarantor_party_reference | String | The reference of the guarantor-party. The entity who is responsible. |
guarantor_party_identifier_value | String | The value of the guarantor-party-identifier. The entity who is responsible. |
guarantor_party_type | String | The guarantor-party-type of the guarantor-party-type. The entity who is responsible. |
guarantor_onHold | Bool | The guarantor-onHold of the guarantor-onHold. A guarantor may be placed on credit hold or otherwise have their role temporarily suspended. |
guarantor_period_start | Datetime | The start of the guarantor-period. The timeframe during which the guarantor accepts responsibility for the account. |
guarantor_period_end | Datetime | The end of the guarantor-period. The timeframe during which the guarantor accepts responsibility for the account. |
partOf_display | String | The display of the partOf. Reference to a parent Account. |
partOf_reference | String | The reference of the partOf. Reference to a parent Account. |
partOf_identifier_value | String | The value of the partOf-identifier. Reference to a parent Account. |
partOf_type | String | The partOf-type of the partOf-type. Reference to a parent Account. |
SP_owner | String | Entity managing the Account. |
SP_source | String | Identifies where the resource comes from. |
SP_text | String | Search on the narrative of the resource. |
SP_content | String | Search on the entire content of the resource. |
SP_securitySP_start | String | Security Labels applied to this resource. |
SP_tagSP_start | String | Tags applied to this resource. |
SP_subject | String | The entity that caused the expenses. |
SP_identifier_start | String | Account number. |
SP_type_start | String | E.g. patient, expense, depreciation. |
SP_list | String | . |
SP_type_end | String | E.g. patient, expense, depreciation. |
SP_identifier_end | String | Account number. |
SP_profile | String | Profiles this resource claims to conform to. |
SP_tagSP_end | String | Tags applied to this resource. |
SP_patient | String | The entity that caused the expenses. |
SP_securitySP_end | String | Security Labels applied to this resource. |
SP_period | String | Transaction window. |
SP_filter | String | Search the contents of the resource's data using a filter. |
ActivityDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers. |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_start | String | The start of the identifier-period. A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_end | String | The end of the identifier-period. A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
version | String | The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets. |
name | String | A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
title | String | A short, descriptive, user-friendly title for the activity definition. |
subtitle | String | An explanatory or alternate title for the activity definition giving additional information about its content. |
status | String | The status of this activity definition. Enables tracking the life-cycle of the content. |
experimental | Bool | A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
subject_x_coding | String | The coding of the subject[x]. A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. |
subject_x_text | String | The text of the subject[x]. A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. |
date | Datetime | The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes. |
publisher | String | The name of the organization or individual that published the activity definition. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
description | String | A free text natural language description of the activity definition from a consumer's perspective. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances. |
jurisdiction_coding | String | The coding of the jurisdiction. A legal or geographic region in which the activity definition is intended to be used. |
jurisdiction_text | String | The text of the jurisdiction. A legal or geographic region in which the activity definition is intended to be used. |
purpose | String | Explanation of why this activity definition is needed and why it has been designed as it has. |
usage | String | A detailed description of how the activity definition is used from a clinical perspective. |
copyright | String | A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition. |
approvalDate | Date | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
lastReviewDate | Date | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
effectivePeriod_start | Datetime | The start of the effectivePeriod. The period during which the activity definition content was or is planned to be in active use. |
effectivePeriod_end | Datetime | The end of the effectivePeriod. The period during which the activity definition content was or is planned to be in active use. |
topic_coding | String | The coding of the topic. Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching. |
topic_text | String | The text of the topic. Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching. |
author | String | An individiual or organization primarily involved in the creation and maintenance of the content. |
editor | String | An individual or organization primarily responsible for internal coherence of the content. |
reviewer | String | An individual or organization primarily responsible for review of some aspect of the content. |
endorser | String | An individual or organization responsible for officially endorsing the content for use in some setting. |
relatedArtifact | String | Related artifacts such as additional documentation, justification, or bibliographic references. |
library | String | A reference to a Library resource containing any formal logic used by the activity definition. |
kind | String | A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource. |
profile | String | A profile to which the target of the activity definition is expected to conform. |
code_coding | String | The coding of the code. Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. |
code_text | String | The text of the code. Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. |
intent | String | Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain. |
priority | String | Indicates how quickly the activity should be addressed with respect to other requests. |
doNotPerform | Bool | Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action. |
timing_x_ | String | The period, timing or frequency upon which the described activity is to occur. |
location_display | String | The display of the location. Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
location_reference | String | The reference of the location. Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
location_identifier_value | String | The value of the location-identifier. Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
location_type | String | The location-type of the location-type. Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
participant_id | String | The participant-id of the participant-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
participant_extension | String | The participant-extension of the participant-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
participant_modifierExtension | String | The participant-modifierExtension of the participant-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
participant_type | String | The participant-type of the participant-type. The type of participant in the action. |
participant_role_coding | String | The coding of the participant-role. The role the participant should play in performing the described action. |
participant_role_text | String | The text of the participant-role. The role the participant should play in performing the described action. |
product_x_display | String | The display of the product[x]. Identifies the food, drug or other product being consumed or supplied in the activity. |
product_x_reference | String | The reference of the product[x]. Identifies the food, drug or other product being consumed or supplied in the activity. |
product_x_identifier_value | String | The value of the product[x]-identifier. Identifies the food, drug or other product being consumed or supplied in the activity. |
product_x_type | String | The product[x]-type of the product[x]-type. Identifies the food, drug or other product being consumed or supplied in the activity. |
quantity_value | Decimal | The value of the quantity. Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). |
quantity_unit | String | The unit of the quantity. Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). |
quantity_system | String | The system of the quantity. Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). |
quantity_comparator | String | The quantity-comparator of the quantity-comparator. Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). |
quantity_code | String | The quantity-code of the quantity-code. Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). |
dosage_system | String | The system of the dosage. Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. |
dosage_comparator | String | The dosage-comparator of the dosage-comparator. Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. |
bodySite_coding | String | The coding of the bodySite. Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). |
bodySite_text | String | The text of the bodySite. Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). |
specimenRequirement_display | String | The display of the specimenRequirement. Defines specimen requirements for the action to be performed, such as required specimens for a lab test. |
specimenRequirement_reference | String | The reference of the specimenRequirement. Defines specimen requirements for the action to be performed, such as required specimens for a lab test. |
specimenRequirement_identifier_value | String | The value of the specimenRequirement-identifier. Defines specimen requirements for the action to be performed, such as required specimens for a lab test. |
specimenRequirement_type | String | The specimenRequirement-type of the specimenRequirement-type. Defines specimen requirements for the action to be performed, such as required specimens for a lab test. |
observationRequirement_display | String | The display of the observationRequirement. Defines observation requirements for the action to be performed, such as body weight or surface area. |
observationRequirement_reference | String | The reference of the observationRequirement. Defines observation requirements for the action to be performed, such as body weight or surface area. |
observationRequirement_identifier_value | String | The value of the observationRequirement-identifier. Defines observation requirements for the action to be performed, such as body weight or surface area. |
observationRequirement_type | String | The observationRequirement-type of the observationRequirement-type. Defines observation requirements for the action to be performed, such as body weight or surface area. |
observationResultRequirement_display | String | The display of the observationResultRequirement. Defines the observations that are expected to be produced by the action. |
observationResultRequirement_reference | String | The reference of the observationResultRequirement. Defines the observations that are expected to be produced by the action. |
observationResultRequirement_identifier_value | String | The value of the observationResultRequirement-identifier. Defines the observations that are expected to be produced by the action. |
observationResultRequirement_type | String | The observationResultRequirement-type of the observationResultRequirement-type. Defines the observations that are expected to be produced by the action. |
transform | String | A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. |
dynamicValue_id | String | The dynamicValue-id of the dynamicValue-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
dynamicValue_extension | String | The dynamicValue-extension of the dynamicValue-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
dynamicValue_modifierExtension | String | The dynamicValue-modifierExtension of the dynamicValue-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
dynamicValue_path | String | The dynamicValue-path of the dynamicValue-path. The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). |
dynamicValue_expression | String | The dynamicValue-expression of the dynamicValue-expression. An expression specifying the value of the customized element. |
SP_context_end | String | The SP_context_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_depends_on | String | The SP_depends_on search parameter. |
SP_predecessor | String | The SP_predecessor search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_jurisdiction_start | String | The SP_jurisdiction_start search parameter. |
SP_effective | String | The SP_effective search parameter. |
SP_topic_end | String | The SP_topic_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_context_type_start | String | The SP_context_type_start search parameter. |
SP_context_quantity | String | The SP_context_quantity search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_context_type_value | String | The SP_context_type_value search parameter. |
SP_successor | String | The SP_successor search parameter. |
SP_context_type_quantity | String | The SP_context_type_quantity search parameter. |
SP_derived_from | String | The SP_derived_from search parameter. |
SP_context_type_end | String | The SP_context_type_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_context_start | String | The SP_context_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_composed_of | String | The SP_composed_of search parameter. |
SP_jurisdiction_end | String | The SP_jurisdiction_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_topic_start | String | The SP_topic_start search parameter. |
AdministrableProductDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. An identifier for the administrable product. |
identifier_use | String | The identifier-use of the identifier-use. An identifier for the administrable product. |
identifier_type_coding | String | The coding of the identifier-type. An identifier for the administrable product. |
identifier_type_text | String | The text of the identifier-type. An identifier for the administrable product. |
identifier_system | String | The identifier-system of the identifier-system. An identifier for the administrable product. |
identifier_period_start | String | The start of the identifier-period. An identifier for the administrable product. |
identifier_period_end | String | The end of the identifier-period. An identifier for the administrable product. |
status | String | The status of this administrable product. Enables tracking the life-cycle of the content. |
formOf_display | String | The display of the formOf. The medicinal product that this is a prepared administrable form of. This element is not a reference to the item(s) that make up this administrable form (for which see AdministrableProductDefinition.producedFrom). It is medicinal product as a whole, which may have several components (as well as packaging, devices etc.), that are given to the patient in this final administrable form. A single medicinal product may have several different administrable products (e.g. a tablet and a cream), and these could have different administrable forms (e.g. tablet as oral solid, or tablet crushed). |
formOf_reference | String | The reference of the formOf. The medicinal product that this is a prepared administrable form of. This element is not a reference to the item(s) that make up this administrable form (for which see AdministrableProductDefinition.producedFrom). It is medicinal product as a whole, which may have several components (as well as packaging, devices etc.), that are given to the patient in this final administrable form. A single medicinal product may have several different administrable products (e.g. a tablet and a cream), and these could have different administrable forms (e.g. tablet as oral solid, or tablet crushed). |
formOf_identifier_value | String | The value of the formOf-identifier. The medicinal product that this is a prepared administrable form of. This element is not a reference to the item(s) that make up this administrable form (for which see AdministrableProductDefinition.producedFrom). It is medicinal product as a whole, which may have several components (as well as packaging, devices etc.), that are given to the patient in this final administrable form. A single medicinal product may have several different administrable products (e.g. a tablet and a cream), and these could have different administrable forms (e.g. tablet as oral solid, or tablet crushed). |
formOf_type | String | The formOf-type of the formOf-type. The medicinal product that this is a prepared administrable form of. This element is not a reference to the item(s) that make up this administrable form (for which see AdministrableProductDefinition.producedFrom). It is medicinal product as a whole, which may have several components (as well as packaging, devices etc.), that are given to the patient in this final administrable form. A single medicinal product may have several different administrable products (e.g. a tablet and a cream), and these could have different administrable forms (e.g. tablet as oral solid, or tablet crushed). |
administrableDoseForm_coding | String | The coding of the administrableDoseForm. The dose form of the final product after necessary reconstitution or processing. Contrasts to the manufactured dose form (see ManufacturedItemDefinition). If the manufactured form was 'powder for solution for injection', the administrable dose form could be 'solution for injection' (once mixed with another item having manufactured form 'solvent for solution for injection'). |
administrableDoseForm_text | String | The text of the administrableDoseForm. The dose form of the final product after necessary reconstitution or processing. Contrasts to the manufactured dose form (see ManufacturedItemDefinition). If the manufactured form was 'powder for solution for injection', the administrable dose form could be 'solution for injection' (once mixed with another item having manufactured form 'solvent for solution for injection'). |
unitOfPresentation_coding | String | The coding of the unitOfPresentation. The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' (as in 'contains 100 mcg per puff'), or for a liquid - 'vial' (as in 'contains 5 ml per vial'). |
unitOfPresentation_text | String | The text of the unitOfPresentation. The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' (as in 'contains 100 mcg per puff'), or for a liquid - 'vial' (as in 'contains 5 ml per vial'). |
producedFrom_display | String | The display of the producedFrom. The constituent manufactured item(s) that this administrable product is produced from. Either a single item, or several that are mixed before administration (e.g. a power item and a solvent item, to make a consumable solution). Note the items this is produced from are not raw ingredients (see AdministrableProductDefinition.ingredient), but manufactured medication items (ManufacturedItemDefinitions), which may be combined or prepared and transformed for patient use. The constituent items that this administrable form is produced from are all part of the product (for which see AdministrableProductDefinition.formOf). |
producedFrom_reference | String | The reference of the producedFrom. The constituent manufactured item(s) that this administrable product is produced from. Either a single item, or several that are mixed before administration (e.g. a power item and a solvent item, to make a consumable solution). Note the items this is produced from are not raw ingredients (see AdministrableProductDefinition.ingredient), but manufactured medication items (ManufacturedItemDefinitions), which may be combined or prepared and transformed for patient use. The constituent items that this administrable form is produced from are all part of the product (for which see AdministrableProductDefinition.formOf). |
producedFrom_identifier_value | String | The value of the producedFrom-identifier. The constituent manufactured item(s) that this administrable product is produced from. Either a single item, or several that are mixed before administration (e.g. a power item and a solvent item, to make a consumable solution). Note the items this is produced from are not raw ingredients (see AdministrableProductDefinition.ingredient), but manufactured medication items (ManufacturedItemDefinitions), which may be combined or prepared and transformed for patient use. The constituent items that this administrable form is produced from are all part of the product (for which see AdministrableProductDefinition.formOf). |
producedFrom_type | String | The producedFrom-type of the producedFrom-type. The constituent manufactured item(s) that this administrable product is produced from. Either a single item, or several that are mixed before administration (e.g. a power item and a solvent item, to make a consumable solution). Note the items this is produced from are not raw ingredients (see AdministrableProductDefinition.ingredient), but manufactured medication items (ManufacturedItemDefinitions), which may be combined or prepared and transformed for patient use. The constituent items that this administrable form is produced from are all part of the product (for which see AdministrableProductDefinition.formOf). |
ingredient_coding | String | The coding of the ingredient. The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton (via AdministrableProductDefinition.producedFrom) to state which component items are used to make this, or using by incoming references from the Ingredient resource, to state in detail which substances exist within this. This element allows a basic coded ingredient to be used. |
ingredient_text | String | The text of the ingredient. The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton (via AdministrableProductDefinition.producedFrom) to state which component items are used to make this, or using by incoming references from the Ingredient resource, to state in detail which substances exist within this. This element allows a basic coded ingredient to be used. |
device_display | String | The display of the device. A device that is integral to the medicinal product, in effect being considered as an 'ingredient' of the medicinal product. This is not intended for devices that are just co-packaged. |
device_reference | String | The reference of the device. A device that is integral to the medicinal product, in effect being considered as an 'ingredient' of the medicinal product. This is not intended for devices that are just co-packaged. |
device_identifier_value | String | The value of the device-identifier. A device that is integral to the medicinal product, in effect being considered as an 'ingredient' of the medicinal product. This is not intended for devices that are just co-packaged. |
device_type | String | The device-type of the device-type. A device that is integral to the medicinal product, in effect being considered as an 'ingredient' of the medicinal product. This is not intended for devices that are just co-packaged. |
property_id | String | The property-id of the property-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
property_extension | String | The property-extension of the property-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
property_modifierExtension | String | The property-modifierExtension of the property-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
property_type_coding | String | The coding of the property-type. A code expressing the type of characteristic. |
property_type_text | String | The text of the property-type. A code expressing the type of characteristic. |
property_value_x_coding | String | The coding of the property-value[x]. A value for the characteristic. |
property_value_x_text | String | The text of the property-value[x]. A value for the characteristic. |
property_status_coding | String | The coding of the property-status. The status of characteristic e.g. assigned or pending. |
property_status_text | String | The text of the property-status. The status of characteristic e.g. assigned or pending. |
routeOfAdministration_id | String | The routeOfAdministration-id of the routeOfAdministration-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
routeOfAdministration_extension | String | The routeOfAdministration-extension of the routeOfAdministration-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
routeOfAdministration_modifierExtension | String | The routeOfAdministration-modifierExtension of the routeOfAdministration-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
routeOfAdministration_code_coding | String | The coding of the routeOfAdministration-code. Coded expression for the route. |
routeOfAdministration_code_text | String | The text of the routeOfAdministration-code. Coded expression for the route. |
routeOfAdministration_firstDose_value | Decimal | The value of the routeOfAdministration-firstDose. The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement. |
routeOfAdministration_firstDose_unit | String | The unit of the routeOfAdministration-firstDose. The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement. |
routeOfAdministration_firstDose_system | String | The system of the routeOfAdministration-firstDose. The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement. |
routeOfAdministration_firstDose_comparator | String | The routeOfAdministration-firstDose-comparator of the routeOfAdministration-firstDose-comparator. The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement. |
routeOfAdministration_firstDose_code | String | The routeOfAdministration-firstDose-code of the routeOfAdministration-firstDose-code. The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement. |
routeOfAdministration_maxSingleDose_value | Decimal | The value of the routeOfAdministration-maxSingleDose. The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement. |
routeOfAdministration_maxSingleDose_unit | String | The unit of the routeOfAdministration-maxSingleDose. The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement. |
routeOfAdministration_maxSingleDose_system | String | The system of the routeOfAdministration-maxSingleDose. The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement. |
routeOfAdministration_maxSingleDose_comparator | String | The routeOfAdministration-maxSingleDose-comparator of the routeOfAdministration-maxSingleDose-comparator. The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement. |
routeOfAdministration_maxSingleDose_code | String | The routeOfAdministration-maxSingleDose-code of the routeOfAdministration-maxSingleDose-code. The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement. |
routeOfAdministration_maxDosePerDay_value | Decimal | The value of the routeOfAdministration-maxDosePerDay. The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered. |
routeOfAdministration_maxDosePerDay_unit | String | The unit of the routeOfAdministration-maxDosePerDay. The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered. |
routeOfAdministration_maxDosePerDay_system | String | The system of the routeOfAdministration-maxDosePerDay. The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered. |
routeOfAdministration_maxDosePerDay_comparator | String | The routeOfAdministration-maxDosePerDay-comparator of the routeOfAdministration-maxDosePerDay-comparator. The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered. |
routeOfAdministration_maxDosePerDay_code | String | The routeOfAdministration-maxDosePerDay-code of the routeOfAdministration-maxDosePerDay-code. The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered. |
routeOfAdministration_maxDosePerTreatmentPeriod | String | The routeOfAdministration-maxDosePerTreatmentPeriod of the routeOfAdministration-maxDosePerTreatmentPeriod. The maximum dose per treatment period that can be administered. |
routeOfAdministration_maxTreatmentPeriod | String | The routeOfAdministration-maxTreatmentPeriod of the routeOfAdministration-maxTreatmentPeriod. The maximum treatment period during which an Investigational Medicinal Product can be administered. |
routeOfAdministration_targetSpecies_id | String | The routeOfAdministration-targetSpecies-id of the routeOfAdministration-targetSpecies-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
routeOfAdministration_targetSpecies_extension | String | The routeOfAdministration-targetSpecies-extension of the routeOfAdministration-targetSpecies-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
routeOfAdministration_targetSpecies_modifierExtension | String | The routeOfAdministration-targetSpecies-modifierExtension of the routeOfAdministration-targetSpecies-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
routeOfAdministration_targetSpecies_code_coding | String | The coding of the routeOfAdministration-targetSpecies-code. Coded expression for the species. |
routeOfAdministration_targetSpecies_code_text | String | The text of the routeOfAdministration-targetSpecies-code. Coded expression for the species. |
routeOfAdministration_targetSpecies_withdrawalPeriod_id | String | The routeOfAdministration-targetSpecies-withdrawalPeriod-id of the routeOfAdministration-targetSpecies-withdrawalPeriod-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
routeOfAdministration_targetSpecies_withdrawalPeriod_extension | String | The routeOfAdministration-targetSpecies-withdrawalPeriod-extension of the routeOfAdministration-targetSpecies-withdrawalPeriod-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
routeOfAdministration_targetSpecies_withdrawalPeriod_modifierExtension | String | The routeOfAdministration-targetSpecies-withdrawalPeriod-modifierExtension of the routeOfAdministration-targetSpecies-withdrawalPeriod-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
routeOfAdministration_targetSpecies_withdrawalPeriod_tissue_coding | String | The coding of the routeOfAdministration-targetSpecies-withdrawalPeriod-tissue. Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk. |
routeOfAdministration_targetSpecies_withdrawalPeriod_tissue_text | String | The text of the routeOfAdministration-targetSpecies-withdrawalPeriod-tissue. Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk. |
routeOfAdministration_targetSpecies_withdrawalPeriod_value_value | Decimal | The value of the routeOfAdministration-targetSpecies-withdrawalPeriod-value. A value for the time. |
routeOfAdministration_targetSpecies_withdrawalPeriod_value_unit | String | The unit of the routeOfAdministration-targetSpecies-withdrawalPeriod-value. A value for the time. |
routeOfAdministration_targetSpecies_withdrawalPeriod_value_system | String | The system of the routeOfAdministration-targetSpecies-withdrawalPeriod-value. A value for the time. |
routeOfAdministration_targetSpecies_withdrawalPeriod_value_comparator | String | The routeOfAdministration-targetSpecies-withdrawalPeriod-value-comparator of the routeOfAdministration-targetSpecies-withdrawalPeriod-value-comparator. A value for the time. |
routeOfAdministration_targetSpecies_withdrawalPeriod_value_code | String | The routeOfAdministration-targetSpecies-withdrawalPeriod-value-code of the routeOfAdministration-targetSpecies-withdrawalPeriod-value-code. A value for the time. |
routeOfAdministration_targetSpecies_withdrawalPeriod_supportingInformation | String | The routeOfAdministration-targetSpecies-withdrawalPeriod-supportingInformation of the routeOfAdministration-targetSpecies-withdrawalPeriod-supportingInformation. Extra information about the withdrawal period. |
SP_source | String | The SP_source search parameter. |
SP_form_of | String | The SP_form_of search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_route_start | String | The SP_route_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_dose_form_start | String | The SP_dose_form_start search parameter. |
SP_manufactured_item | String | The SP_manufactured_item search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_route_end | String | The SP_route_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_dose_form_end | String | The SP_dose_form_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_device | String | The SP_device search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_ingredient_start | String | The SP_ingredient_start search parameter. |
SP_target_species_end | String | The SP_target_species_end search parameter. |
SP_ingredient_end | String | The SP_ingredient_end search parameter. |
SP_target_species_start | String | The SP_target_species_start search parameter. |
AdverseEvent view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | Datetime | The start of the identifier-period. Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | Datetime | The end of the identifier-period. Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
actuality | String | Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely. |
category_coding | String | The coding of the category. The overall type of event, intended for search and filtering purposes. |
category_text | String | The text of the category. The overall type of event, intended for search and filtering purposes. |
event_coding | String | The coding of the event. This element defines the specific type of event that occurred or that was prevented from occurring. |
event_text | String | The text of the event. This element defines the specific type of event that occurred or that was prevented from occurring. |
subject_display | String | The display of the subject. This subject or group impacted by the event. |
subject_reference | String | The reference of the subject. This subject or group impacted by the event. |
subject_identifier_value | String | The value of the subject-identifier. This subject or group impacted by the event. |
subject_type | String | The subject-type of the subject-type. This subject or group impacted by the event. |
encounter_display | String | The display of the encounter. The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated. |
encounter_reference | String | The reference of the encounter. The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated. |
encounter_identifier_value | String | The value of the encounter-identifier. The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated. |
encounter_type | String | The encounter-type of the encounter-type. The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated. |
date | Datetime | The date (and perhaps time) when the adverse event occurred. |
detected | Datetime | Estimated or actual date the AdverseEvent began, in the opinion of the reporter. |
recordedDate | Datetime | The date on which the existence of the AdverseEvent was first recorded. |
resultingCondition_display | String | The display of the resultingCondition. Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical). |
resultingCondition_reference | String | The reference of the resultingCondition. Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical). |
resultingCondition_identifier_value | String | The value of the resultingCondition-identifier. Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical). |
resultingCondition_type | String | The resultingCondition-type of the resultingCondition-type. Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical). |
location_display | String | The display of the location. The information about where the adverse event occurred. |
location_reference | String | The reference of the location. The information about where the adverse event occurred. |
location_identifier_value | String | The value of the location-identifier. The information about where the adverse event occurred. |
location_type | String | The location-type of the location-type. The information about where the adverse event occurred. |
seriousness_coding | String | The coding of the seriousness. Assessment whether this event was of real importance. |
seriousness_text | String | The text of the seriousness. Assessment whether this event was of real importance. |
severity_coding | String | The coding of the severity. Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is. |
severity_text | String | The text of the severity. Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is. |
outcome_coding | String | The coding of the outcome. Describes the type of outcome from the adverse event. |
outcome_text | String | The text of the outcome. Describes the type of outcome from the adverse event. |
recorder_display | String | The display of the recorder. Information on who recorded the adverse event. May be the patient or a practitioner. |
recorder_reference | String | The reference of the recorder. Information on who recorded the adverse event. May be the patient or a practitioner. |
recorder_identifier_value | String | The value of the recorder-identifier. Information on who recorded the adverse event. May be the patient or a practitioner. |
recorder_type | String | The recorder-type of the recorder-type. Information on who recorded the adverse event. May be the patient or a practitioner. |
contributor_display | String | The display of the contributor. Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness). |
contributor_reference | String | The reference of the contributor. Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness). |
contributor_identifier_value | String | The value of the contributor-identifier. Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness). |
contributor_type | String | The contributor-type of the contributor-type. Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness). |
suspectEntity_id | String | The suspectEntity-id of the suspectEntity-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
suspectEntity_extension | String | The suspectEntity-extension of the suspectEntity-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
suspectEntity_modifierExtension | String | The suspectEntity-modifierExtension of the suspectEntity-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
suspectEntity_instance_display | String | The display of the suspectEntity-instance. Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device. |
suspectEntity_instance_reference | String | The reference of the suspectEntity-instance. Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device. |
suspectEntity_instance_identifier_value | String | The value of the suspectEntity-instance-identifier. Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device. |
suspectEntity_instance_type | String | The suspectEntity-instance-type of the suspectEntity-instance-type. Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device. |
suspectEntity_causality_id | String | The suspectEntity-causality-id of the suspectEntity-causality-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
suspectEntity_causality_extension | String | The suspectEntity-causality-extension of the suspectEntity-causality-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
suspectEntity_causality_modifierExtension | String | The suspectEntity-causality-modifierExtension of the suspectEntity-causality-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
suspectEntity_causality_assessment_coding | String | The coding of the suspectEntity-causality-assessment. Assessment of if the entity caused the event. |
suspectEntity_causality_assessment_text | String | The text of the suspectEntity-causality-assessment. Assessment of if the entity caused the event. |
suspectEntity_causality_productRelatedness | String | The suspectEntity-causality-productRelatedness of the suspectEntity-causality-productRelatedness. AdverseEvent.suspectEntity.causalityProductRelatedness. |
suspectEntity_causality_author_display | String | The display of the suspectEntity-causality-author. AdverseEvent.suspectEntity.causalityAuthor. |
suspectEntity_causality_author_reference | String | The reference of the suspectEntity-causality-author. AdverseEvent.suspectEntity.causalityAuthor. |
suspectEntity_causality_author_identifier_value | String | The value of the suspectEntity-causality-author-identifier. AdverseEvent.suspectEntity.causalityAuthor. |
suspectEntity_causality_author_type | String | The suspectEntity-causality-author-type of the suspectEntity-causality-author-type. AdverseEvent.suspectEntity.causalityAuthor. |
suspectEntity_causality_method_coding | String | The coding of the suspectEntity-causality-method. ProbabilityScale | Bayesian | Checklist. |
suspectEntity_causality_method_text | String | The text of the suspectEntity-causality-method. ProbabilityScale | Bayesian | Checklist. |
subjectMedicalHistory_display | String | The display of the subjectMedicalHistory. AdverseEvent.subjectMedicalHistory. |
subjectMedicalHistory_reference | String | The reference of the subjectMedicalHistory. AdverseEvent.subjectMedicalHistory. |
subjectMedicalHistory_identifier_value | String | The value of the subjectMedicalHistory-identifier. AdverseEvent.subjectMedicalHistory. |
subjectMedicalHistory_type | String | The subjectMedicalHistory-type of the subjectMedicalHistory-type. AdverseEvent.subjectMedicalHistory. |
referenceDocument_display | String | The display of the referenceDocument. AdverseEvent.referenceDocument. |
referenceDocument_reference | String | The reference of the referenceDocument. AdverseEvent.referenceDocument. |
referenceDocument_identifier_value | String | The value of the referenceDocument-identifier. AdverseEvent.referenceDocument. |
referenceDocument_type | String | The referenceDocument-type of the referenceDocument-type. AdverseEvent.referenceDocument. |
study_display | String | The display of the study. AdverseEvent.study. |
study_reference | String | The reference of the study. AdverseEvent.study. |
study_identifier_value | String | The value of the study-identifier. AdverseEvent.study. |
study_type | String | The study-type of the study-type. AdverseEvent.study. |
SP_location | String | The SP_location search parameter. |
SP_source | String | The SP_source search parameter. |
SP_event_start | String | The SP_event_start search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_recorder | String | The SP_recorder search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_event_end | String | The SP_event_end search parameter. |
SP_seriousness_start | String | The SP_seriousness_start search parameter. |
SP_severity_start | String | The SP_severity_start search parameter. |
SP_severity_end | String | The SP_severity_end search parameter. |
SP_study | String | The SP_study search parameter. |
SP_substance | String | The SP_substance search parameter. |
SP_list | String | The SP_list search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_resultingcondition | String | The SP_resultingcondition search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_seriousness_end | String | The SP_seriousness_end search parameter. |
AllergyIntolerance view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
clinicalStatus_coding | String | The coding of the clinicalStatus. The clinical status of the allergy or intolerance. |
clinicalStatus_text | String | The text of the clinicalStatus. The clinical status of the allergy or intolerance. |
verificationStatus_coding | String | The coding of the verificationStatus. Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). |
verificationStatus_text | String | The text of the verificationStatus. Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). |
type | String | Identification of the underlying physiological mechanism for the reaction risk. |
category | String | Category of the identified substance. |
criticality | String | Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. |
code_coding | String | The coding of the code. Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., 'Latex'), an allergy or intolerance condition (e.g., 'Latex allergy'), or a negated/excluded code for a specific substance or class (e.g., 'No latex allergy') or a general or categorical negated statement (e.g., 'No known allergy', 'No known drug allergies'). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance. |
code_text | String | The text of the code. Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., 'Latex'), an allergy or intolerance condition (e.g., 'Latex allergy'), or a negated/excluded code for a specific substance or class (e.g., 'No latex allergy') or a general or categorical negated statement (e.g., 'No known allergy', 'No known drug allergies'). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance. |
patient_display | String | The display of the patient. The patient who has the allergy or intolerance. |
patient_reference | String | The reference of the patient. The patient who has the allergy or intolerance. |
patient_identifier_value | String | The value of the patient-identifier. The patient who has the allergy or intolerance. |
patient_type | String | The patient-type of the patient-type. The patient who has the allergy or intolerance. |
encounter_display | String | The display of the encounter. The encounter when the allergy or intolerance was asserted. |
encounter_reference | String | The reference of the encounter. The encounter when the allergy or intolerance was asserted. |
encounter_identifier_value | String | The value of the encounter-identifier. The encounter when the allergy or intolerance was asserted. |
encounter_type | String | The encounter-type of the encounter-type. The encounter when the allergy or intolerance was asserted. |
onset_x_ | Datetime | Estimated or actual date, date-time, or age when allergy or intolerance was identified. |
recordedDate | Datetime | The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date. |
recorder_display | String | The display of the recorder. Individual who recorded the record and takes responsibility for its content. |
recorder_reference | String | The reference of the recorder. Individual who recorded the record and takes responsibility for its content. |
recorder_identifier_value | String | The value of the recorder-identifier. Individual who recorded the record and takes responsibility for its content. |
recorder_type | String | The recorder-type of the recorder-type. Individual who recorded the record and takes responsibility for its content. |
asserter_display | String | The display of the asserter. The source of the information about the allergy that is recorded. |
asserter_reference | String | The reference of the asserter. The source of the information about the allergy that is recorded. |
asserter_identifier_value | String | The value of the asserter-identifier. The source of the information about the allergy that is recorded. |
asserter_type | String | The asserter-type of the asserter-type. The source of the information about the allergy that is recorded. |
lastOccurrence | Datetime | Represents the date and/or time of the last known occurrence of a reaction event. |
note | String | Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. |
reaction_id | String | The reaction-id of the reaction-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
reaction_extension | String | The reaction-extension of the reaction-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
reaction_modifierExtension | String | The reaction-modifierExtension of the reaction-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
reaction_substance_coding | String | The coding of the reaction-substance. Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance. |
reaction_substance_text | String | The text of the reaction-substance. Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance. |
reaction_manifestation_coding | String | The coding of the reaction-manifestation. Clinical symptoms and/or signs that are observed or associated with the adverse reaction event. |
reaction_manifestation_text | String | The text of the reaction-manifestation. Clinical symptoms and/or signs that are observed or associated with the adverse reaction event. |
reaction_description | String | The reaction-description of the reaction-description. Text description about the reaction as a whole, including details of the manifestation if required. |
reaction_onset | Datetime | The reaction-onset of the reaction-onset. Record of the date and/or time of the onset of the Reaction. |
reaction_severity | String | The reaction-severity of the reaction-severity. Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations. |
reaction_exposureRoute_coding | String | The coding of the reaction-exposureRoute. Identification of the route by which the subject was exposed to the substance. |
reaction_exposureRoute_text | String | The text of the reaction-exposureRoute. Identification of the route by which the subject was exposed to the substance. |
reaction_note | String | The reaction-note of the reaction-note. Additional text about the adverse reaction event not captured in other fields. |
SP_source | String | The SP_source search parameter. |
SP_manifestation_end | String | The SP_manifestation_end search parameter. |
SP_asserter | String | The SP_asserter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_route_start | String | The SP_route_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_recorder | String | The SP_recorder search parameter. |
SP_clinical_status_end | String | The SP_clinical_status_end search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_severity_start | String | The SP_severity_start search parameter. |
SP_severity_end | String | The SP_severity_end search parameter. |
SP_onset | String | The SP_onset search parameter. |
SP_clinical_status_start | String | The SP_clinical_status_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_route_end | String | The SP_route_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_manifestation_start | String | The SP_manifestation_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_verification_status_end | String | The SP_verification_status_end search parameter. |
SP_last_date | String | The SP_last_date search parameter. |
SP_date | String | The SP_date search parameter. |
SP_verification_status_start | String | The SP_verification_status_start search parameter. |
Appointment view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
identifier_use | String | The identifier-use of the identifier-use. This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
identifier_type_coding | String | The coding of the identifier-type. This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
identifier_type_text | String | The text of the identifier-type. This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
identifier_system | String | The identifier-system of the identifier-system. This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
identifier_period_start | String | The start of the identifier-period. This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
identifier_period_end | String | The end of the identifier-period. This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
status | String | The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status. |
cancelationReason_coding | String | The coding of the cancelationReason. The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply. |
cancelationReason_text | String | The text of the cancelationReason. The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply. |
serviceCategory_coding | String | The coding of the serviceCategory. A broad categorization of the service that is to be performed during this appointment. |
serviceCategory_text | String | The text of the serviceCategory. A broad categorization of the service that is to be performed during this appointment. |
serviceType_coding | String | The coding of the serviceType. The specific service that is to be performed during this appointment. |
serviceType_text | String | The text of the serviceType. The specific service that is to be performed during this appointment. |
specialty_coding | String | The coding of the specialty. The specialty of a practitioner that would be required to perform the service requested in this appointment. |
specialty_text | String | The text of the specialty. The specialty of a practitioner that would be required to perform the service requested in this appointment. |
appointmentType_coding | String | The coding of the appointmentType. The style of appointment or patient that has been booked in the slot (not service type). |
appointmentType_text | String | The text of the appointmentType. The style of appointment or patient that has been booked in the slot (not service type). |
reasonCode_coding | String | The coding of the reasonCode. The coded reason that this appointment is being scheduled. This is more clinical than administrative. |
reasonCode_text | String | The text of the reasonCode. The coded reason that this appointment is being scheduled. This is more clinical than administrative. |
reasonReference_display | String | The display of the reasonReference. Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. |
reasonReference_reference | String | The reference of the reasonReference. Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. |
priority | String | The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority). |
description | String | The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field. |
supportingInformation_display | String | The display of the supportingInformation. Additional information to support the appointment provided when making the appointment. |
supportingInformation_reference | String | The reference of the supportingInformation. Additional information to support the appointment provided when making the appointment. |
supportingInformation_identifier_value | String | The value of the supportingInformation-identifier. Additional information to support the appointment provided when making the appointment. |
supportingInformation_type | String | The supportingInformation-type of the supportingInformation-type. Additional information to support the appointment provided when making the appointment. |
start | String | Date/Time that the appointment is to take place. |
end | String | Date/Time that the appointment is to conclude. |
minutesDuration | Int | Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end. |
slot_display | String | The display of the slot. The slots from the participants' schedules that will be filled by the appointment. |
slot_reference | String | The reference of the slot. The slots from the participants' schedules that will be filled by the appointment. |
slot_identifier_value | String | The value of the slot-identifier. The slots from the participants' schedules that will be filled by the appointment. |
slot_type | String | The slot-type of the slot-type. The slots from the participants' schedules that will be filled by the appointment. |
created | Datetime | The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment. |
comment | String | Additional comments about the appointment. |
patientInstruction | String | While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before). |
basedOn_display | String | The display of the basedOn. The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). |
basedOn_reference | String | The reference of the basedOn. The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). |
basedOn_identifier_value | String | The value of the basedOn-identifier. The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). |
basedOn_type | String | The basedOn-type of the basedOn-type. The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). |
participant_id | String | The participant-id of the participant-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
participant_extension | String | The participant-extension of the participant-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
participant_modifierExtension | String | The participant-modifierExtension of the participant-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
participant_type_coding | String | The coding of the participant-type. Role of participant in the appointment. |
participant_type_text | String | The text of the participant-type. Role of participant in the appointment. |
participant_actor_display | String | The display of the participant-actor. A Person, Location/HealthcareService or Device that is participating in the appointment. |
participant_actor_reference | String | The reference of the participant-actor. A Person, Location/HealthcareService or Device that is participating in the appointment. |
participant_actor_identifier_value | String | The value of the participant-actor-identifier. A Person, Location/HealthcareService or Device that is participating in the appointment. |
participant_actor_type | String | The participant-actor-type of the participant-actor-type. A Person, Location/HealthcareService or Device that is participating in the appointment. |
participant_required | String | The participant-required of the participant-required. Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present. |
participant_status | String | The participant-status of the participant-status. Participation status of the actor. |
participant_period_start | Datetime | The start of the participant-period. Participation period of the actor. |
participant_period_end | Datetime | The end of the participant-period. Participation period of the actor. |
requestedPeriod_start | String | The start of the requestedPeriod. A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system. |
requestedPeriod_end | String | The end of the requestedPeriod. A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system. |
SP_location | String | The SP_location search parameter. |
SP_source | String | The SP_source search parameter. |
SP_appointment_type_end | String | The SP_appointment_type_end search parameter. |
SP_actor | String | The SP_actor search parameter. |
SP_text | String | The SP_text search parameter. |
SP_service_category_end | String | The SP_service_category_end search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_slot | String | The SP_slot search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_reason_reference | String | The SP_reason_reference search parameter. |
SP_specialty_end | String | The SP_specialty_end search parameter. |
SP_part_status_start | String | The SP_part_status_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_based_on | String | The SP_based_on search parameter. |
SP_practitioner | String | The SP_practitioner search parameter. |
SP_list | String | The SP_list search parameter. |
SP_reason_code_start | String | The SP_reason_code_start search parameter. |
SP_part_status_end | String | The SP_part_status_end search parameter. |
SP_service_category_start | String | The SP_service_category_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_specialty_start | String | The SP_specialty_start search parameter. |
SP_service_type_start | String | The SP_service_type_start search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_appointment_type_start | String | The SP_appointment_type_start search parameter. |
SP_supporting_info | String | The SP_supporting_info search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_reason_code_end | String | The SP_reason_code_end search parameter. |
SP_service_type_end | String | The SP_service_type_end search parameter. |
SP_date | String | The SP_date search parameter. |
AppointmentResponse view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
identifier_use | String | The identifier-use of the identifier-use. This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
identifier_type_coding | String | The coding of the identifier-type. This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
identifier_type_text | String | The text of the identifier-type. This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
identifier_system | String | The identifier-system of the identifier-system. This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
identifier_period_start | String | The start of the identifier-period. This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
identifier_period_end | String | The end of the identifier-period. This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
appointment_display | String | The display of the appointment. Appointment that this response is replying to. |
appointment_reference | String | The reference of the appointment. Appointment that this response is replying to. |
appointment_identifier_value | String | The value of the appointment-identifier. Appointment that this response is replying to. |
appointment_type | String | The appointment-type of the appointment-type. Appointment that this response is replying to. |
start | String | Date/Time that the appointment is to take place, or requested new start time. |
end | String | This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time. |
participantType_coding | String | The coding of the participantType. Role of participant in the appointment. |
participantType_text | String | The text of the participantType. Role of participant in the appointment. |
actor_display | String | The display of the actor. A Person, Location, HealthcareService, or Device that is participating in the appointment. |
actor_reference | String | The reference of the actor. A Person, Location, HealthcareService, or Device that is participating in the appointment. |
actor_identifier_value | String | The value of the actor-identifier. A Person, Location, HealthcareService, or Device that is participating in the appointment. |
actor_type | String | The actor-type of the actor-type. A Person, Location, HealthcareService, or Device that is participating in the appointment. |
participantStatus | String | Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty. |
comment | String | Additional comments about the appointment. |
SP_location | String | The SP_location search parameter. |
SP_source | String | The SP_source search parameter. |
SP_actor | String | The SP_actor search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_appointment | String | The SP_appointment search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_part_status_start | String | The SP_part_status_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_practitioner | String | The SP_practitioner search parameter. |
SP_list | String | The SP_list search parameter. |
SP_part_status_end | String | The SP_part_status_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
AuditEvent view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
type_version | String | The version of the type. Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. |
type_code | String | The code of the type. Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. |
type_display | String | The display of the type. Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. |
type_userSelected | Bool | The userSelected of the type. Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. |
type_system | String | The type-system of the type-system. Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. |
subtype_version | String | The version of the subtype. Identifier for the category of event. |
subtype_code | String | The code of the subtype. Identifier for the category of event. |
subtype_display | String | The display of the subtype. Identifier for the category of event. |
subtype_userSelected | String | The userSelected of the subtype. Identifier for the category of event. |
subtype_system | String | The subtype-system of the subtype-system. Identifier for the category of event. |
action | String | Indicator for type of action performed during the event that generated the audit. |
period_start | Datetime | The start of the period. The period during which the activity occurred. |
period_end | Datetime | The end of the period. The period during which the activity occurred. |
recorded | String | The time when the event was recorded. |
outcome | String | Indicates whether the event succeeded or failed. |
outcomeDesc | String | A free text description of the outcome of the event. |
purposeOfEvent_coding | String | The coding of the purposeOfEvent. The purposeOfUse (reason) that was used during the event being recorded. |
purposeOfEvent_text | String | The text of the purposeOfEvent. The purposeOfUse (reason) that was used during the event being recorded. |
agent_id | String | The agent-id of the agent-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
agent_extension | String | The agent-extension of the agent-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
agent_modifierExtension | String | The agent-modifierExtension of the agent-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
agent_type_coding | String | The coding of the agent-type. Specification of the participation type the user plays when performing the event. |
agent_type_text | String | The text of the agent-type. Specification of the participation type the user plays when performing the event. |
agent_role_coding | String | The coding of the agent-role. The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context. |
agent_role_text | String | The text of the agent-role. The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context. |
agent_who_display | String | The display of the agent-who. Reference to who this agent is that was involved in the event. |
agent_who_reference | String | The reference of the agent-who. Reference to who this agent is that was involved in the event. |
agent_who_identifier_value | String | The value of the agent-who-identifier. Reference to who this agent is that was involved in the event. |
agent_who_type | String | The agent-who-type of the agent-who-type. Reference to who this agent is that was involved in the event. |
agent_altId | String | The agent-altId of the agent-altId. Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available. |
agent_name | String | The agent-name of the agent-name. Human-meaningful name for the agent. |
agent_requestor | Bool | The agent-requestor of the agent-requestor. Indicator that the user is or is not the requestor, or initiator, for the event being audited. |
agent_location_display | String | The display of the agent-location. Where the event occurred. |
agent_location_reference | String | The reference of the agent-location. Where the event occurred. |
agent_location_identifier_value | String | The value of the agent-location-identifier. Where the event occurred. |
agent_location_type | String | The agent-location-type of the agent-location-type. Where the event occurred. |
agent_policy | String | The agent-policy of the agent-policy. The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used. |
agent_media_version | String | The version of the agent-media. Type of media involved. Used when the event is about exporting/importing onto media. |
agent_media_code | String | The code of the agent-media. Type of media involved. Used when the event is about exporting/importing onto media. |
agent_media_display | String | The display of the agent-media. Type of media involved. Used when the event is about exporting/importing onto media. |
agent_media_userSelected | Bool | The userSelected of the agent-media. Type of media involved. Used when the event is about exporting/importing onto media. |
agent_media_system | String | The agent-media-system of the agent-media-system. Type of media involved. Used when the event is about exporting/importing onto media. |
agent_network_id | String | The agent-network-id of the agent-network-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
agent_network_extension | String | The agent-network-extension of the agent-network-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
agent_network_modifierExtension | String | The agent-network-modifierExtension of the agent-network-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
agent_network_address | String | The agent-network-address of the agent-network-address. An identifier for the network access point of the user device for the audit event. |
agent_network_type | String | The agent-network-type of the agent-network-type. An identifier for the type of network access point that originated the audit event. |
agent_purposeOfUse_coding | String | The coding of the agent-purposeOfUse. The reason (purpose of use), specific to this agent, that was used during the event being recorded. |
agent_purposeOfUse_text | String | The text of the agent-purposeOfUse. The reason (purpose of use), specific to this agent, that was used during the event being recorded. |
source_id | String | The source-id of the source-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
source_extension | String | The source-extension of the source-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
source_modifierExtension | String | The source-modifierExtension of the source-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
source_site | String | The source-site of the source-site. Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group. |
source_observer_display | String | The display of the source-observer. Identifier of the source where the event was detected. |
source_observer_reference | String | The reference of the source-observer. Identifier of the source where the event was detected. |
source_observer_identifier_value | String | The value of the source-observer-identifier. Identifier of the source where the event was detected. |
source_observer_type | String | The source-observer-type of the source-observer-type. Identifier of the source where the event was detected. |
source_type_version | String | The version of the source-type. Code specifying the type of source where event originated. |
source_type_code | String | The code of the source-type. Code specifying the type of source where event originated. |
source_type_display | String | The display of the source-type. Code specifying the type of source where event originated. |
source_type_userSelected | String | The userSelected of the source-type. Code specifying the type of source where event originated. |
source_type_system | String | The source-type-system of the source-type-system. Code specifying the type of source where event originated. |
entity_id | String | The entity-id of the entity-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
entity_extension | String | The entity-extension of the entity-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
entity_modifierExtension | String | The entity-modifierExtension of the entity-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
entity_what_display | String | The display of the entity-what. Identifies a specific instance of the entity. The reference should be version specific. |
entity_what_reference | String | The reference of the entity-what. Identifies a specific instance of the entity. The reference should be version specific. |
entity_what_identifier_value | String | The value of the entity-what-identifier. Identifies a specific instance of the entity. The reference should be version specific. |
entity_what_type | String | The entity-what-type of the entity-what-type. Identifies a specific instance of the entity. The reference should be version specific. |
entity_type_version | String | The version of the entity-type. The type of the object that was involved in this audit event. |
entity_type_code | String | The code of the entity-type. The type of the object that was involved in this audit event. |
entity_type_display | String | The display of the entity-type. The type of the object that was involved in this audit event. |
entity_type_userSelected | Bool | The userSelected of the entity-type. The type of the object that was involved in this audit event. |
entity_type_system | String | The entity-type-system of the entity-type-system. The type of the object that was involved in this audit event. |
entity_role_version | String | The version of the entity-role. Code representing the role the entity played in the event being audited. |
entity_role_code | String | The code of the entity-role. Code representing the role the entity played in the event being audited. |
entity_role_display | String | The display of the entity-role. Code representing the role the entity played in the event being audited. |
entity_role_userSelected | Bool | The userSelected of the entity-role. Code representing the role the entity played in the event being audited. |
entity_role_system | String | The entity-role-system of the entity-role-system. Code representing the role the entity played in the event being audited. |
entity_lifecycle_version | String | The version of the entity-lifecycle. Identifier for the data life-cycle stage for the entity. |
entity_lifecycle_code | String | The code of the entity-lifecycle. Identifier for the data life-cycle stage for the entity. |
entity_lifecycle_display | String | The display of the entity-lifecycle. Identifier for the data life-cycle stage for the entity. |
entity_lifecycle_userSelected | Bool | The userSelected of the entity-lifecycle. Identifier for the data life-cycle stage for the entity. |
entity_lifecycle_system | String | The entity-lifecycle-system of the entity-lifecycle-system. Identifier for the data life-cycle stage for the entity. |
entity_securityLabel_version | String | The version of the entity-securityLabel. Security labels for the identified entity. |
entity_securityLabel_code | String | The code of the entity-securityLabel. Security labels for the identified entity. |
entity_securityLabel_display | String | The display of the entity-securityLabel. Security labels for the identified entity. |
entity_securityLabel_userSelected | String | The userSelected of the entity-securityLabel. Security labels for the identified entity. |
entity_securityLabel_system | String | The entity-securityLabel-system of the entity-securityLabel-system. Security labels for the identified entity. |
entity_name | String | The entity-name of the entity-name. A name of the entity in the audit event. |
entity_description | String | The entity-description of the entity-description. Text that describes the entity in more detail. |
entity_query | String | The entity-query of the entity-query. The query parameters for a query-type entities. |
entity_detail_id | String | The entity-detail-id of the entity-detail-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
entity_detail_extension | String | The entity-detail-extension of the entity-detail-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
entity_detail_modifierExtension | String | The entity-detail-modifierExtension of the entity-detail-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
entity_detail_type | String | The entity-detail-type of the entity-detail-type. The type of extra detail provided in the value. |
entity_detail_value_x_ | String | The entity-detail-value[x] of the entity-detail-value[x]. The value of the extra detail. |
SP_source | String | The SP_source search parameter. |
SP_agent | String | The SP_agent search parameter. |
SP_entity_type_end | String | The SP_entity_type_end search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_agent_role_start | String | The SP_agent_role_start search parameter. |
SP_address | String | The SP_address search parameter. |
SP_entity_role_end | String | The SP_entity_role_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_altid_end | String | The SP_altid_end search parameter. |
SP_altid_start | String | The SP_altid_start search parameter. |
SP_entity | String | The SP_entity search parameter. |
SP_subtype_end | String | The SP_subtype_end search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_policy | String | The SP_policy search parameter. |
SP_site_end | String | The SP_site_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_entity_role_start | String | The SP_entity_role_start search parameter. |
SP_source | String | The SP_source search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_agent_role_end | String | The SP_agent_role_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_subtype_start | String | The SP_subtype_start search parameter. |
SP_entity_type_start | String | The SP_entity_type_start search parameter. |
SP_site_start | String | The SP_site_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_date | String | The SP_date search parameter. |
BiologicallyDerivedProduct view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
identifier_use | String | The identifier-use of the identifier-use. This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
identifier_type_coding | String | The coding of the identifier-type. This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
identifier_type_text | String | The text of the identifier-type. This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
identifier_system | String | The identifier-system of the identifier-system. This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
identifier_period_start | String | The start of the identifier-period. This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
identifier_period_end | String | The end of the identifier-period. This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
productCategory | String | Broad category of this product. |
productCode_coding | String | The coding of the productCode. A code that identifies the kind of this biologically derived product (SNOMED Ctcode). |
productCode_text | String | The text of the productCode. A code that identifies the kind of this biologically derived product (SNOMED Ctcode). |
status | String | Whether the product is currently available. |
request_display | String | The display of the request. Procedure request to obtain this biologically derived product. |
request_reference | String | The reference of the request. Procedure request to obtain this biologically derived product. |
request_identifier_value | String | The value of the request-identifier. Procedure request to obtain this biologically derived product. |
request_type | String | The request-type of the request-type. Procedure request to obtain this biologically derived product. |
quantity | Int | Number of discrete units within this product. |
parent_display | String | The display of the parent. Parent product (if any). |
parent_reference | String | The reference of the parent. Parent product (if any). |
parent_identifier_value | String | The value of the parent-identifier. Parent product (if any). |
parent_type | String | The parent-type of the parent-type. Parent product (if any). |
collection_id | String | The collection-id of the collection-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
collection_extension | String | The collection-extension of the collection-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
collection_modifierExtension | String | The collection-modifierExtension of the collection-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
collection_collector_display | String | The display of the collection-collector. Healthcare professional who is performing the collection. |
collection_collector_reference | String | The reference of the collection-collector. Healthcare professional who is performing the collection. |
collection_collector_identifier_value | String | The value of the collection-collector-identifier. Healthcare professional who is performing the collection. |
collection_collector_type | String | The collection-collector-type of the collection-collector-type. Healthcare professional who is performing the collection. |
collection_source_display | String | The display of the collection-source. The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product. |
collection_source_reference | String | The reference of the collection-source. The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product. |
collection_source_identifier_value | String | The value of the collection-source-identifier. The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product. |
collection_source_type | String | The collection-source-type of the collection-source-type. The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product. |
collection_collected_x_ | Datetime | The collection-collected[x] of the collection-collected[x]. Time of product collection. |
processing_id | String | The processing-id of the processing-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
processing_extension | String | The processing-extension of the processing-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
processing_modifierExtension | String | The processing-modifierExtension of the processing-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
processing_description | String | The processing-description of the processing-description. Description of of processing. |
processing_procedure_coding | String | The coding of the processing-procedure. Procesing code. |
processing_procedure_text | String | The text of the processing-procedure. Procesing code. |
processing_additive_display | String | The display of the processing-additive. Substance added during processing. |
processing_additive_reference | String | The reference of the processing-additive. Substance added during processing. |
processing_additive_identifier_value | String | The value of the processing-additive-identifier. Substance added during processing. |
processing_additive_type | String | The processing-additive-type of the processing-additive-type. Substance added during processing. |
processing_time_x_ | Datetime | The processing-time[x] of the processing-time[x]. Time of processing. |
manipulation_id | String | The manipulation-id of the manipulation-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
manipulation_extension | String | The manipulation-extension of the manipulation-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
manipulation_modifierExtension | String | The manipulation-modifierExtension of the manipulation-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
manipulation_description | String | The manipulation-description of the manipulation-description. Description of manipulation. |
manipulation_time_x_ | Datetime | The manipulation-time[x] of the manipulation-time[x]. Time of manipulation. |
storage_id | String | The storage-id of the storage-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
storage_extension | String | The storage-extension of the storage-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
storage_modifierExtension | String | The storage-modifierExtension of the storage-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
storage_description | String | The storage-description of the storage-description. Description of storage. |
storage_temperature | Decimal | The storage-temperature of the storage-temperature. Storage temperature. |
storage_scale | String | The storage-scale of the storage-scale. Temperature scale used. |
storage_duration_start | Datetime | The start of the storage-duration. Storage timeperiod. |
storage_duration_end | Datetime | The end of the storage-duration. Storage timeperiod. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
BodyStructure view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifier for this instance of the anatomical structure. |
identifier_use | String | The identifier-use of the identifier-use. Identifier for this instance of the anatomical structure. |
identifier_type_coding | String | The coding of the identifier-type. Identifier for this instance of the anatomical structure. |
identifier_type_text | String | The text of the identifier-type. Identifier for this instance of the anatomical structure. |
identifier_system | String | The identifier-system of the identifier-system. Identifier for this instance of the anatomical structure. |
identifier_period_start | String | The start of the identifier-period. Identifier for this instance of the anatomical structure. |
identifier_period_end | String | The end of the identifier-period. Identifier for this instance of the anatomical structure. |
active | Bool | Whether this body site is in active use. |
morphology_coding | String | The coding of the morphology. The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies. |
morphology_text | String | The text of the morphology. The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies. |
location_coding | String | The coding of the location. The anatomical location or region of the specimen, lesion, or body structure. |
location_text | String | The text of the location. The anatomical location or region of the specimen, lesion, or body structure. |
locationQualifier_coding | String | The coding of the locationQualifier. Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane. |
locationQualifier_text | String | The text of the locationQualifier. Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane. |
description | String | A summary, characterization or explanation of the body structure. |
image_data | String | The data of the image. Image or images used to identify a location. |
image_url | String | The url of the image. Image or images used to identify a location. |
image_size | String | The size of the image. Image or images used to identify a location. |
image_title | String | The title of the image. Image or images used to identify a location. |
image_creation | String | The creation of the image. Image or images used to identify a location. |
image_height | String | The height of the image. Image or images used to identify a location. |
image_width | String | The width of the image. Image or images used to identify a location. |
image_frames | String | The frames of the image. Image or images used to identify a location. |
image_duration | String | The duration of the image. Image or images used to identify a location. |
image_pages | String | The pages of the image. Image or images used to identify a location. |
image_contentType | String | The image-contentType of the image-contentType. Image or images used to identify a location. |
image_language | String | The image-language of the image-language. Image or images used to identify a location. |
patient_display | String | The display of the patient. The person to which the body site belongs. |
patient_reference | String | The reference of the patient. The person to which the body site belongs. |
patient_identifier_value | String | The value of the patient-identifier. The person to which the body site belongs. |
patient_type | String | The patient-type of the patient-type. The person to which the body site belongs. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_morphology_end | String | The SP_morphology_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_location_start | String | The SP_location_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_location_end | String | The SP_location_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_morphology_start | String | The SP_morphology_start search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
CarePlan view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
instantiatesCanonical | String | The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan. |
instantiatesUri | String | The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan. |
basedOn_display | String | The display of the basedOn. A care plan that is fulfilled in whole or in part by this care plan. |
basedOn_reference | String | The reference of the basedOn. A care plan that is fulfilled in whole or in part by this care plan. |
basedOn_identifier_value | String | The value of the basedOn-identifier. A care plan that is fulfilled in whole or in part by this care plan. |
basedOn_type | String | The basedOn-type of the basedOn-type. A care plan that is fulfilled in whole or in part by this care plan. |
replaces_display | String | The display of the replaces. Completed or terminated care plan whose function is taken by this new care plan. |
replaces_reference | String | The reference of the replaces. Completed or terminated care plan whose function is taken by this new care plan. |
replaces_identifier_value | String | The value of the replaces-identifier. Completed or terminated care plan whose function is taken by this new care plan. |
replaces_type | String | The replaces-type of the replaces-type. Completed or terminated care plan whose function is taken by this new care plan. |
partOf_display | String | The display of the partOf. A larger care plan of which this particular care plan is a component or step. |
partOf_reference | String | The reference of the partOf. A larger care plan of which this particular care plan is a component or step. |
partOf_identifier_value | String | The value of the partOf-identifier. A larger care plan of which this particular care plan is a component or step. |
partOf_type | String | The partOf-type of the partOf-type. A larger care plan of which this particular care plan is a component or step. |
status | String | Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. |
intent | String | Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. |
category_coding | String | The coding of the category. Identifies what 'kind' of plan this is to support differentiation between multiple co-existing plans; e.g. 'Home health', 'psychiatric', 'asthma', 'disease management', 'wellness plan', etc. |
category_text | String | The text of the category. Identifies what 'kind' of plan this is to support differentiation between multiple co-existing plans; e.g. 'Home health', 'psychiatric', 'asthma', 'disease management', 'wellness plan', etc. |
title | String | Human-friendly name for the care plan. |
description | String | A description of the scope and nature of the plan. |
subject_display | String | The display of the subject. Identifies the patient or group whose intended care is described by the plan. |
subject_reference | String | The reference of the subject. Identifies the patient or group whose intended care is described by the plan. |
subject_identifier_value | String | The value of the subject-identifier. Identifies the patient or group whose intended care is described by the plan. |
subject_type | String | The subject-type of the subject-type. Identifies the patient or group whose intended care is described by the plan. |
encounter_display | String | The display of the encounter. The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated. |
encounter_reference | String | The reference of the encounter. The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated. |
encounter_identifier_value | String | The value of the encounter-identifier. The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated. |
encounter_type | String | The encounter-type of the encounter-type. The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated. |
period_start | Datetime | The start of the period. Indicates when the plan did (or is intended to) come into effect and end. |
period_end | Datetime | The end of the period. Indicates when the plan did (or is intended to) come into effect and end. |
created | Datetime | Represents when this particular CarePlan record was created in the system, which is often a system-generated date. |
author_display | String | The display of the author. When populated, the author is responsible for the care plan. The care plan is attributed to the author. |
author_reference | String | The reference of the author. When populated, the author is responsible for the care plan. The care plan is attributed to the author. |
author_identifier_value | String | The value of the author-identifier. When populated, the author is responsible for the care plan. The care plan is attributed to the author. |
author_type | String | The author-type of the author-type. When populated, the author is responsible for the care plan. The care plan is attributed to the author. |
contributor_display | String | The display of the contributor. Identifies the individual(s) or organization who provided the contents of the care plan. |
contributor_reference | String | The reference of the contributor. Identifies the individual(s) or organization who provided the contents of the care plan. |
contributor_identifier_value | String | The value of the contributor-identifier. Identifies the individual(s) or organization who provided the contents of the care plan. |
contributor_type | String | The contributor-type of the contributor-type. Identifies the individual(s) or organization who provided the contents of the care plan. |
careTeam_display | String | The display of the careTeam. Identifies all people and organizations who are expected to be involved in the care envisioned by this plan. |
careTeam_reference | String | The reference of the careTeam. Identifies all people and organizations who are expected to be involved in the care envisioned by this plan. |
careTeam_identifier_value | String | The value of the careTeam-identifier. Identifies all people and organizations who are expected to be involved in the care envisioned by this plan. |
careTeam_type | String | The careTeam-type of the careTeam-type. Identifies all people and organizations who are expected to be involved in the care envisioned by this plan. |
addresses_display | String | The display of the addresses. Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. |
addresses_reference | String | The reference of the addresses. Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. |
addresses_identifier_value | String | The value of the addresses-identifier. Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. |
addresses_type | String | The addresses-type of the addresses-type. Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. |
supportingInfo_display | String | The display of the supportingInfo. Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc. |
supportingInfo_reference | String | The reference of the supportingInfo. Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc. |
supportingInfo_identifier_value | String | The value of the supportingInfo-identifier. Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc. |
supportingInfo_type | String | The supportingInfo-type of the supportingInfo-type. Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc. |
goal_display | String | The display of the goal. Describes the intended objective(s) of carrying out the care plan. |
goal_reference | String | The reference of the goal. Describes the intended objective(s) of carrying out the care plan. |
goal_identifier_value | String | The value of the goal-identifier. Describes the intended objective(s) of carrying out the care plan. |
goal_type | String | The goal-type of the goal-type. Describes the intended objective(s) of carrying out the care plan. |
activity_id | String | The activity-id of the activity-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
activity_extension | String | The activity-extension of the activity-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
activity_modifierExtension | String | The activity-modifierExtension of the activity-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
activity_outcomeCodeableConcept_coding | String | The coding of the activity-outcomeCodeableConcept. Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not). |
activity_outcomeCodeableConcept_text | String | The text of the activity-outcomeCodeableConcept. Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not). |
activity_outcomeReference_display | String | The display of the activity-outcomeReference. Details of the outcome or action resulting from the activity. The reference to an 'event' resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a 'request' resource). |
activity_outcomeReference_reference | String | The reference of the activity-outcomeReference. Details of the outcome or action resulting from the activity. The reference to an 'event' resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a 'request' resource). |
activity_outcomeReference_identifier_value | String | The value of the activity-outcomeReference-identifier. Details of the outcome or action resulting from the activity. The reference to an 'event' resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a 'request' resource). |
activity_outcomeReference_type | String | The activity-outcomeReference-type of the activity-outcomeReference-type. Details of the outcome or action resulting from the activity. The reference to an 'event' resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a 'request' resource). |
activity_progress | String | The activity-progress of the activity-progress. Notes about the adherence/status/progress of the activity. |
activity_reference_display | String | The display of the activity-reference. The details of the proposed activity represented in a specific resource. |
activity_reference_reference | String | The reference of the activity-reference. The details of the proposed activity represented in a specific resource. |
activity_reference_identifier_value | String | The value of the activity-reference-identifier. The details of the proposed activity represented in a specific resource. |
activity_reference_type | String | The activity-reference-type of the activity-reference-type. The details of the proposed activity represented in a specific resource. |
activity_detail_id | String | The activity-detail-id of the activity-detail-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
activity_detail_extension | String | The activity-detail-extension of the activity-detail-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
activity_detail_modifierExtension | String | The activity-detail-modifierExtension of the activity-detail-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
activity_detail_kind | String | The activity-detail-kind of the activity-detail-kind. A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. |
activity_detail_instantiatesCanonical | String | The activity-detail-instantiatesCanonical of the activity-detail-instantiatesCanonical. The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. |
activity_detail_instantiatesUri | String | The activity-detail-instantiatesUri of the activity-detail-instantiatesUri. The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. |
activity_detail_code_coding | String | The coding of the activity-detail-code. Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter. |
activity_detail_code_text | String | The text of the activity-detail-code. Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter. |
activity_detail_reasonCode_coding | String | The coding of the activity-detail-reasonCode. Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited. |
activity_detail_reasonCode_text | String | The text of the activity-detail-reasonCode. Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited. |
activity_detail_reasonReference_display | String | The display of the activity-detail-reasonReference. Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan. |
activity_detail_reasonReference_reference | String | The reference of the activity-detail-reasonReference. Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan. |
activity_detail_reasonReference_identifier_value | String | The value of the activity-detail-reasonReference-identifier. Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan. |
activity_detail_reasonReference_type | String | The activity-detail-reasonReference-type of the activity-detail-reasonReference-type. Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan. |
activity_detail_goal_display | String | The display of the activity-detail-goal. Internal reference that identifies the goals that this activity is intended to contribute towards meeting. |
activity_detail_goal_reference | String | The reference of the activity-detail-goal. Internal reference that identifies the goals that this activity is intended to contribute towards meeting. |
activity_detail_goal_identifier_value | String | The value of the activity-detail-goal-identifier. Internal reference that identifies the goals that this activity is intended to contribute towards meeting. |
activity_detail_goal_type | String | The activity-detail-goal-type of the activity-detail-goal-type. Internal reference that identifies the goals that this activity is intended to contribute towards meeting. |
activity_detail_status | String | The activity-detail-status of the activity-detail-status. Identifies what progress is being made for the specific activity. |
activity_detail_statusReason_coding | String | The coding of the activity-detail-statusReason. Provides reason why the activity isn't yet started, is on hold, was cancelled, etc. |
activity_detail_statusReason_text | String | The text of the activity-detail-statusReason. Provides reason why the activity isn't yet started, is on hold, was cancelled, etc. |
activity_detail_doNotPerform | Bool | The activity-detail-doNotPerform of the activity-detail-doNotPerform. If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan. |
activity_detail_scheduled_x_ | String | The activity-detail-scheduled[x] of the activity-detail-scheduled[x]. The period, timing or frequency upon which the described activity is to occur. |
activity_detail_location_display | String | The display of the activity-detail-location. Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
activity_detail_location_reference | String | The reference of the activity-detail-location. Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
activity_detail_location_identifier_value | String | The value of the activity-detail-location-identifier. Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
activity_detail_location_type | String | The activity-detail-location-type of the activity-detail-location-type. Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
activity_detail_performer_display | String | The display of the activity-detail-performer. Identifies who's expected to be involved in the activity. |
activity_detail_performer_reference | String | The reference of the activity-detail-performer. Identifies who's expected to be involved in the activity. |
activity_detail_performer_identifier_value | String | The value of the activity-detail-performer-identifier. Identifies who's expected to be involved in the activity. |
activity_detail_performer_type | String | The activity-detail-performer-type of the activity-detail-performer-type. Identifies who's expected to be involved in the activity. |
activity_detail_product_x_coding | String | The coding of the activity-detail-product[x]. Identifies the food, drug or other product to be consumed or supplied in the activity. |
activity_detail_product_x_text | String | The text of the activity-detail-product[x]. Identifies the food, drug or other product to be consumed or supplied in the activity. |
activity_detail_dailyAmount_value | Decimal | The value of the activity-detail-dailyAmount. Identifies the quantity expected to be consumed in a given day. |
activity_detail_dailyAmount_unit | String | The unit of the activity-detail-dailyAmount. Identifies the quantity expected to be consumed in a given day. |
activity_detail_dailyAmount_system | String | The system of the activity-detail-dailyAmount. Identifies the quantity expected to be consumed in a given day. |
activity_detail_dailyAmount_comparator | String | The activity-detail-dailyAmount-comparator of the activity-detail-dailyAmount-comparator. Identifies the quantity expected to be consumed in a given day. |
activity_detail_dailyAmount_code | String | The activity-detail-dailyAmount-code of the activity-detail-dailyAmount-code. Identifies the quantity expected to be consumed in a given day. |
activity_detail_quantity_value | Decimal | The value of the activity-detail-quantity. Identifies the quantity expected to be supplied, administered or consumed by the subject. |
activity_detail_quantity_unit | String | The unit of the activity-detail-quantity. Identifies the quantity expected to be supplied, administered or consumed by the subject. |
activity_detail_quantity_system | String | The system of the activity-detail-quantity. Identifies the quantity expected to be supplied, administered or consumed by the subject. |
activity_detail_quantity_comparator | String | The activity-detail-quantity-comparator of the activity-detail-quantity-comparator. Identifies the quantity expected to be supplied, administered or consumed by the subject. |
activity_detail_quantity_code | String | The activity-detail-quantity-code of the activity-detail-quantity-code. Identifies the quantity expected to be supplied, administered or consumed by the subject. |
activity_detail_description | String | The activity-detail-description of the activity-detail-description. This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc. |
note | String | General notes about the care plan not covered elsewhere. |
SP_source | String | The SP_source search parameter. |
SP_performer | String | The SP_performer search parameter. |
SP_instantiates_canonical | String | The SP_instantiates_canonical search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_activity_code_start | String | The SP_activity_code_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_activity_reference | String | The SP_activity_reference search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_instantiates_uri | String | The SP_instantiates_uri search parameter. |
SP_based_on | String | The SP_based_on search parameter. |
SP_activity_code_end | String | The SP_activity_code_end search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_goal | String | The SP_goal search parameter. |
SP_list | String | The SP_list search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_activity_date | String | The SP_activity_date search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_care_team | String | The SP_care_team search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_part_of | String | The SP_part_of search parameter. |
SP_condition | String | The SP_condition search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_date | String | The SP_date search parameter. |
SP_replaces | String | The SP_replaces search parameter. |
CareTeam view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
status | String | Indicates the current state of the care team. |
category_coding | String | The coding of the category. Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team. |
category_text | String | The text of the category. Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team. |
name | String | A label for human use intended to distinguish like teams. E.g. the 'red' vs. 'green' trauma teams. |
subject_display | String | The display of the subject. Identifies the patient or group whose intended care is handled by the team. |
subject_reference | String | The reference of the subject. Identifies the patient or group whose intended care is handled by the team. |
subject_identifier_value | String | The value of the subject-identifier. Identifies the patient or group whose intended care is handled by the team. |
subject_type | String | The subject-type of the subject-type. Identifies the patient or group whose intended care is handled by the team. |
encounter_display | String | The display of the encounter. The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated. |
encounter_reference | String | The reference of the encounter. The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated. |
encounter_identifier_value | String | The value of the encounter-identifier. The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated. |
encounter_type | String | The encounter-type of the encounter-type. The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated. |
period_start | Datetime | The start of the period. Indicates when the team did (or is intended to) come into effect and end. |
period_end | Datetime | The end of the period. Indicates when the team did (or is intended to) come into effect and end. |
participant_id | String | The participant-id of the participant-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
participant_extension | String | The participant-extension of the participant-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
participant_modifierExtension | String | The participant-modifierExtension of the participant-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
participant_role_coding | String | The coding of the participant-role. Indicates specific responsibility of an individual within the care team, such as 'Primary care physician', 'Trained social worker counselor', 'Caregiver', etc. |
participant_role_text | String | The text of the participant-role. Indicates specific responsibility of an individual within the care team, such as 'Primary care physician', 'Trained social worker counselor', 'Caregiver', etc. |
participant_member_display | String | The display of the participant-member. The specific person or organization who is participating/expected to participate in the care team. |
participant_member_reference | String | The reference of the participant-member. The specific person or organization who is participating/expected to participate in the care team. |
participant_member_identifier_value | String | The value of the participant-member-identifier. The specific person or organization who is participating/expected to participate in the care team. |
participant_member_type | String | The participant-member-type of the participant-member-type. The specific person or organization who is participating/expected to participate in the care team. |
participant_onBehalfOf_display | String | The display of the participant-onBehalfOf. The organization of the practitioner. |
participant_onBehalfOf_reference | String | The reference of the participant-onBehalfOf. The organization of the practitioner. |
participant_onBehalfOf_identifier_value | String | The value of the participant-onBehalfOf-identifier. The organization of the practitioner. |
participant_onBehalfOf_type | String | The participant-onBehalfOf-type of the participant-onBehalfOf-type. The organization of the practitioner. |
participant_period_start | Datetime | The start of the participant-period. Indicates when the specific member or organization did (or is intended to) come into effect and end. |
participant_period_end | Datetime | The end of the participant-period. Indicates when the specific member or organization did (or is intended to) come into effect and end. |
reasonCode_coding | String | The coding of the reasonCode. Describes why the care team exists. |
reasonCode_text | String | The text of the reasonCode. Describes why the care team exists. |
reasonReference_display | String | The display of the reasonReference. Condition(s) that this care team addresses. |
reasonReference_reference | String | The reference of the reasonReference. Condition(s) that this care team addresses. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Condition(s) that this care team addresses. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Condition(s) that this care team addresses. |
managingOrganization_display | String | The display of the managingOrganization. The organization responsible for the care team. |
managingOrganization_reference | String | The reference of the managingOrganization. The organization responsible for the care team. |
managingOrganization_identifier_value | String | The value of the managingOrganization-identifier. The organization responsible for the care team. |
managingOrganization_type | String | The managingOrganization-type of the managingOrganization-type. The organization responsible for the care team. |
telecom_value | String | The value of the telecom. A central contact detail for the care team (that applies to all members). |
telecom_system | String | The telecom-system of the telecom-system. A central contact detail for the care team (that applies to all members). |
telecom_use | String | The telecom-use of the telecom-use. A central contact detail for the care team (that applies to all members). |
telecom_rank | String | The telecom-rank of the telecom-rank. A central contact detail for the care team (that applies to all members). |
telecom_period_start | String | The start of the telecom-period. A central contact detail for the care team (that applies to all members). |
telecom_period_end | String | The end of the telecom-period. A central contact detail for the care team (that applies to all members). |
note | String | Comments made about the CareTeam. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_participant | String | The SP_participant search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_date | String | The SP_date search parameter. |
CatalogEntry view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code. |
identifier_use | String | The identifier-use of the identifier-use. Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code. |
identifier_type_coding | String | The coding of the identifier-type. Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code. |
identifier_type_text | String | The text of the identifier-type. Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code. |
identifier_system | String | The identifier-system of the identifier-system. Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code. |
identifier_period_start | String | The start of the identifier-period. Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code. |
identifier_period_end | String | The end of the identifier-period. Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code. |
type_coding | String | The coding of the type. The type of item - medication, device, service, protocol or other. |
type_text | String | The text of the type. The type of item - medication, device, service, protocol or other. |
orderable | Bool | Whether the entry represents an orderable item. |
referencedItem_display | String | The display of the referencedItem. The item in a catalog or definition. |
referencedItem_reference | String | The reference of the referencedItem. The item in a catalog or definition. |
referencedItem_identifier_value | String | The value of the referencedItem-identifier. The item in a catalog or definition. |
referencedItem_type | String | The referencedItem-type of the referencedItem-type. The item in a catalog or definition. |
additionalIdentifier_value | String | The value of the additionalIdentifier. Used in supporting related concepts, e.g. NDC to RxNorm. |
additionalIdentifier_use | String | The additionalIdentifier-use of the additionalIdentifier-use. Used in supporting related concepts, e.g. NDC to RxNorm. |
additionalIdentifier_type_coding | String | The coding of the additionalIdentifier-type. Used in supporting related concepts, e.g. NDC to RxNorm. |
additionalIdentifier_type_text | String | The text of the additionalIdentifier-type. Used in supporting related concepts, e.g. NDC to RxNorm. |
additionalIdentifier_system | String | The additionalIdentifier-system of the additionalIdentifier-system. Used in supporting related concepts, e.g. NDC to RxNorm. |
additionalIdentifier_period_start | String | The start of the additionalIdentifier-period. Used in supporting related concepts, e.g. NDC to RxNorm. |
additionalIdentifier_period_end | String | The end of the additionalIdentifier-period. Used in supporting related concepts, e.g. NDC to RxNorm. |
classification_coding | String | The coding of the classification. Classes of devices, or ATC for medication. |
classification_text | String | The text of the classification. Classes of devices, or ATC for medication. |
status | String | Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable. |
validityPeriod_start | Datetime | The start of the validityPeriod. The time period in which this catalog entry is expected to be active. |
validityPeriod_end | Datetime | The end of the validityPeriod. The time period in which this catalog entry is expected to be active. |
validTo | Datetime | The date until which this catalog entry is expected to be active. |
lastUpdated | Datetime | Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated. |
additionalCharacteristic_coding | String | The coding of the additionalCharacteristic. Used for examplefor Out of Formulary, or any specifics. |
additionalCharacteristic_text | String | The text of the additionalCharacteristic. Used for examplefor Out of Formulary, or any specifics. |
additionalClassification_coding | String | The coding of the additionalClassification. User for example for ATC classification, or. |
additionalClassification_text | String | The text of the additionalClassification. User for example for ATC classification, or. |
relatedEntry_id | String | The relatedEntry-id of the relatedEntry-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
relatedEntry_extension | String | The relatedEntry-extension of the relatedEntry-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
relatedEntry_modifierExtension | String | The relatedEntry-modifierExtension of the relatedEntry-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
relatedEntry_relationtype | String | The relatedEntry-relationtype of the relatedEntry-relationtype. The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc. |
relatedEntry_item_display | String | The display of the relatedEntry-item. The reference to the related item. |
relatedEntry_item_reference | String | The reference of the relatedEntry-item. The reference to the related item. |
relatedEntry_item_identifier_value | String | The value of the relatedEntry-item-identifier. The reference to the related item. |
relatedEntry_item_type | String | The relatedEntry-item-type of the relatedEntry-item-type. The reference to the related item. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
ChargeItem view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifiers assigned to this event performer or other systems. |
identifier_use | String | The identifier-use of the identifier-use. Identifiers assigned to this event performer or other systems. |
identifier_type_coding | String | The coding of the identifier-type. Identifiers assigned to this event performer or other systems. |
identifier_type_text | String | The text of the identifier-type. Identifiers assigned to this event performer or other systems. |
identifier_system | String | The identifier-system of the identifier-system. Identifiers assigned to this event performer or other systems. |
identifier_period_start | String | The start of the identifier-period. Identifiers assigned to this event performer or other systems. |
identifier_period_end | String | The end of the identifier-period. Identifiers assigned to this event performer or other systems. |
definitionUri | String | References the (external) source of pricing information, rules of application for the code this ChargeItem uses. |
definitionCanonical | String | References the source of pricing information, rules of application for the code this ChargeItem uses. |
status | String | The current state of the ChargeItem. |
partOf_display | String | The display of the partOf. ChargeItems can be grouped to larger ChargeItems covering the whole set. |
partOf_reference | String | The reference of the partOf. ChargeItems can be grouped to larger ChargeItems covering the whole set. |
partOf_identifier_value | String | The value of the partOf-identifier. ChargeItems can be grouped to larger ChargeItems covering the whole set. |
partOf_type | String | The partOf-type of the partOf-type. ChargeItems can be grouped to larger ChargeItems covering the whole set. |
code_coding | String | The coding of the code. A code that identifies the charge, like a billing code. |
code_text | String | The text of the code. A code that identifies the charge, like a billing code. |
subject_display | String | The display of the subject. The individual or set of individuals the action is being or was performed on. |
subject_reference | String | The reference of the subject. The individual or set of individuals the action is being or was performed on. |
subject_identifier_value | String | The value of the subject-identifier. The individual or set of individuals the action is being or was performed on. |
subject_type | String | The subject-type of the subject-type. The individual or set of individuals the action is being or was performed on. |
context_display | String | The display of the context. The encounter or episode of care that establishes the context for this event. |
context_reference | String | The reference of the context. The encounter or episode of care that establishes the context for this event. |
context_identifier_value | String | The value of the context-identifier. The encounter or episode of care that establishes the context for this event. |
context_type | String | The context-type of the context-type. The encounter or episode of care that establishes the context for this event. |
occurrence_x_ | Datetime | Date/time(s) or duration when the charged service was applied. |
performer_id | String | The performer-id of the performer-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
performer_extension | String | The performer-extension of the performer-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
performer_modifierExtension | String | The performer-modifierExtension of the performer-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
performer_function_coding | String | The coding of the performer-function. Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.). |
performer_function_text | String | The text of the performer-function. Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.). |
performer_actor_display | String | The display of the performer-actor. The device, practitioner, etc. who performed or participated in the service. |
performer_actor_reference | String | The reference of the performer-actor. The device, practitioner, etc. who performed or participated in the service. |
performer_actor_identifier_value | String | The value of the performer-actor-identifier. The device, practitioner, etc. who performed or participated in the service. |
performer_actor_type | String | The performer-actor-type of the performer-actor-type. The device, practitioner, etc. who performed or participated in the service. |
performingOrganization_display | String | The display of the performingOrganization. The organization requesting the service. |
performingOrganization_reference | String | The reference of the performingOrganization. The organization requesting the service. |
performingOrganization_identifier_value | String | The value of the performingOrganization-identifier. The organization requesting the service. |
performingOrganization_type | String | The performingOrganization-type of the performingOrganization-type. The organization requesting the service. |
requestingOrganization_display | String | The display of the requestingOrganization. The organization performing the service. |
requestingOrganization_reference | String | The reference of the requestingOrganization. The organization performing the service. |
requestingOrganization_identifier_value | String | The value of the requestingOrganization-identifier. The organization performing the service. |
requestingOrganization_type | String | The requestingOrganization-type of the requestingOrganization-type. The organization performing the service. |
costCenter_display | String | The display of the costCenter. The financial cost center permits the tracking of charge attribution. |
costCenter_reference | String | The reference of the costCenter. The financial cost center permits the tracking of charge attribution. |
costCenter_identifier_value | String | The value of the costCenter-identifier. The financial cost center permits the tracking of charge attribution. |
costCenter_type | String | The costCenter-type of the costCenter-type. The financial cost center permits the tracking of charge attribution. |
quantity_value | Decimal | The value of the quantity. Quantity of which the charge item has been serviced. |
quantity_unit | String | The unit of the quantity. Quantity of which the charge item has been serviced. |
quantity_system | String | The system of the quantity. Quantity of which the charge item has been serviced. |
quantity_comparator | String | The quantity-comparator of the quantity-comparator. Quantity of which the charge item has been serviced. |
quantity_code | String | The quantity-code of the quantity-code. Quantity of which the charge item has been serviced. |
bodysite_coding | String | The coding of the bodysite. The anatomical location where the related service has been applied. |
bodysite_text | String | The text of the bodysite. The anatomical location where the related service has been applied. |
factorOverride | Decimal | Factor overriding the factor determined by the rules associated with the code. |
priceOverride | String | Total price of the charge overriding the list price associated with the code. |
overrideReason | String | If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action. |
enterer_display | String | The display of the enterer. The device, practitioner, etc. who entered the charge item. |
enterer_reference | String | The reference of the enterer. The device, practitioner, etc. who entered the charge item. |
enterer_identifier_value | String | The value of the enterer-identifier. The device, practitioner, etc. who entered the charge item. |
enterer_type | String | The enterer-type of the enterer-type. The device, practitioner, etc. who entered the charge item. |
enteredDate | Datetime | Date the charge item was entered. |
reason_coding | String | The coding of the reason. Describes why the event occurred in coded or textual form. |
reason_text | String | The text of the reason. Describes why the event occurred in coded or textual form. |
service_display | String | The display of the service. Indicated the rendered service that caused this charge. |
service_reference | String | The reference of the service. Indicated the rendered service that caused this charge. |
service_identifier_value | String | The value of the service-identifier. Indicated the rendered service that caused this charge. |
service_type | String | The service-type of the service-type. Indicated the rendered service that caused this charge. |
product_x_display | String | The display of the product[x]. Identifies the device, food, drug or other product being charged either by type code or reference to an instance. |
product_x_reference | String | The reference of the product[x]. Identifies the device, food, drug or other product being charged either by type code or reference to an instance. |
product_x_identifier_value | String | The value of the product[x]-identifier. Identifies the device, food, drug or other product being charged either by type code or reference to an instance. |
product_x_type | String | The product[x]-type of the product[x]-type. Identifies the device, food, drug or other product being charged either by type code or reference to an instance. |
account_display | String | The display of the account. Account into which this ChargeItems belongs. |
account_reference | String | The reference of the account. Account into which this ChargeItems belongs. |
account_identifier_value | String | The value of the account-identifier. Account into which this ChargeItems belongs. |
account_type | String | The account-type of the account-type. Account into which this ChargeItems belongs. |
note | String | Comments made about the event by the performer, subject or other participants. |
supportingInformation_display | String | The display of the supportingInformation. Further information supporting this charge. |
supportingInformation_reference | String | The reference of the supportingInformation. Further information supporting this charge. |
supportingInformation_identifier_value | String | The value of the supportingInformation-identifier. Further information supporting this charge. |
supportingInformation_type | String | The supportingInformation-type of the supportingInformation-type. Further information supporting this charge. |
SP_source | String | The SP_source search parameter. |
SP_factor_override | String | The SP_factor_override search parameter. |
SP_context | String | The SP_context search parameter. |
SP_text | String | The SP_text search parameter. |
SP_account | String | The SP_account search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_occurrence | String | The SP_occurrence search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_performer_actor | String | The SP_performer_actor search parameter. |
SP_entered_date | String | The SP_entered_date search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_requesting_organization | String | The SP_requesting_organization search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_quantity | String | The SP_quantity search parameter. |
SP_performer_function_end | String | The SP_performer_function_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_price_override | String | The SP_price_override search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_enterer | String | The SP_enterer search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_performing_organization | String | The SP_performing_organization search parameter. |
SP_performer_function_start | String | The SP_performer_function_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_service | String | The SP_service search parameter. |
ChargeItemDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers. |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_start | String | The start of the identifier-period. A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_end | String | The end of the identifier-period. A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
version | String | The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets. |
title | String | A short, descriptive, user-friendly title for the charge item definition. |
derivedFromUri | String | The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition. |
partOf | String | A larger definition of which this particular definition is a component or step. |
replaces | String | As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance. |
status | String | The current state of the ChargeItemDefinition. |
experimental | Bool | A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
date | Datetime | The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes. |
publisher | String | The name of the organization or individual that published the charge item definition. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
description | String | A free text natural language description of the charge item definition from a consumer's perspective. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances. |
jurisdiction_coding | String | The coding of the jurisdiction. A legal or geographic region in which the charge item definition is intended to be used. |
jurisdiction_text | String | The text of the jurisdiction. A legal or geographic region in which the charge item definition is intended to be used. |
copyright | String | A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition. |
approvalDate | Date | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
lastReviewDate | Date | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
effectivePeriod_start | Datetime | The start of the effectivePeriod. The period during which the charge item definition content was or is planned to be in active use. |
effectivePeriod_end | Datetime | The end of the effectivePeriod. The period during which the charge item definition content was or is planned to be in active use. |
code_coding | String | The coding of the code. The defined billing details in this resource pertain to the given billing code. |
code_text | String | The text of the code. The defined billing details in this resource pertain to the given billing code. |
instance_display | String | The display of the instance. The defined billing details in this resource pertain to the given product instance(s). |
instance_reference | String | The reference of the instance. The defined billing details in this resource pertain to the given product instance(s). |
instance_identifier_value | String | The value of the instance-identifier. The defined billing details in this resource pertain to the given product instance(s). |
instance_type | String | The instance-type of the instance-type. The defined billing details in this resource pertain to the given product instance(s). |
applicability_id | String | The applicability-id of the applicability-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
applicability_extension | String | The applicability-extension of the applicability-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
applicability_modifierExtension | String | The applicability-modifierExtension of the applicability-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
applicability_description | String | The applicability-description of the applicability-description. A brief, natural language description of the condition that effectively communicates the intended semantics. |
applicability_language | String | The applicability-language of the applicability-language. The media type of the language for the expression, e.g. 'text/cql' for Clinical Query Language expressions or 'text/fhirpath' for FHIRPath expressions. |
applicability_expression | String | The applicability-expression of the applicability-expression. An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied. |
propertyGroup_id | String | The propertyGroup-id of the propertyGroup-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
propertyGroup_extension | String | The propertyGroup-extension of the propertyGroup-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
propertyGroup_modifierExtension | String | The propertyGroup-modifierExtension of the propertyGroup-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
SP_context_end | String | The SP_context_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_jurisdiction_start | String | The SP_jurisdiction_start search parameter. |
SP_effective | String | The SP_effective search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_context_type_start | String | The SP_context_type_start search parameter. |
SP_context_quantity | String | The SP_context_quantity search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_context_type_value | String | The SP_context_type_value search parameter. |
SP_context_type_quantity | String | The SP_context_type_quantity search parameter. |
SP_context_type_end | String | The SP_context_type_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_context_start | String | The SP_context_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_jurisdiction_end | String | The SP_jurisdiction_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
Claim view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique identifier assigned to this claim. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this claim. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this claim. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this claim. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this claim. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this claim. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this claim. |
status | String | The status of the resource instance. |
type_coding | String | The coding of the type. The category of claim, e.g. oral, pharmacy, vision, institutional, professional. |
type_text | String | The text of the type. The category of claim, e.g. oral, pharmacy, vision, institutional, professional. |
subType_coding | String | The coding of the subType. A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. |
subType_text | String | The text of the subType. A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. |
use | String | A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future. |
patient_display | String | The display of the patient. The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought. |
patient_reference | String | The reference of the patient. The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought. |
patient_identifier_value | String | The value of the patient-identifier. The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought. |
patient_type | String | The patient-type of the patient-type. The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought. |
billablePeriod_start | Datetime | The start of the billablePeriod. The period for which charges are being submitted. |
billablePeriod_end | Datetime | The end of the billablePeriod. The period for which charges are being submitted. |
created | Datetime | The date this resource was created. |
enterer_display | String | The display of the enterer. Individual who created the claim, predetermination or preauthorization. |
enterer_reference | String | The reference of the enterer. Individual who created the claim, predetermination or preauthorization. |
enterer_identifier_value | String | The value of the enterer-identifier. Individual who created the claim, predetermination or preauthorization. |
enterer_type | String | The enterer-type of the enterer-type. Individual who created the claim, predetermination or preauthorization. |
insurer_display | String | The display of the insurer. The Insurer who is target of the request. |
insurer_reference | String | The reference of the insurer. The Insurer who is target of the request. |
insurer_identifier_value | String | The value of the insurer-identifier. The Insurer who is target of the request. |
insurer_type | String | The insurer-type of the insurer-type. The Insurer who is target of the request. |
provider_display | String | The display of the provider. The provider which is responsible for the claim, predetermination or preauthorization. |
provider_reference | String | The reference of the provider. The provider which is responsible for the claim, predetermination or preauthorization. |
provider_identifier_value | String | The value of the provider-identifier. The provider which is responsible for the claim, predetermination or preauthorization. |
provider_type | String | The provider-type of the provider-type. The provider which is responsible for the claim, predetermination or preauthorization. |
priority_coding | String | The coding of the priority. The provider-required urgency of processing the request. Typical values include: stat, routine deferred. |
priority_text | String | The text of the priority. The provider-required urgency of processing the request. Typical values include: stat, routine deferred. |
fundsReserve_coding | String | The coding of the fundsReserve. A code to indicate whether and for whom funds are to be reserved for future claims. |
fundsReserve_text | String | The text of the fundsReserve. A code to indicate whether and for whom funds are to be reserved for future claims. |
related_id | String | The related-id of the related-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
related_extension | String | The related-extension of the related-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
related_modifierExtension | String | The related-modifierExtension of the related-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
related_claim_display | String | The display of the related-claim. Reference to a related claim. |
related_claim_reference | String | The reference of the related-claim. Reference to a related claim. |
related_claim_identifier_value | String | The value of the related-claim-identifier. Reference to a related claim. |
related_claim_type | String | The related-claim-type of the related-claim-type. Reference to a related claim. |
related_relationship_coding | String | The coding of the related-relationship. A code to convey how the claims are related. |
related_relationship_text | String | The text of the related-relationship. A code to convey how the claims are related. |
related_reference_value | String | The value of the related-reference. An alternate organizational reference to the case or file to which this particular claim pertains. |
related_reference_use | String | The related-reference-use of the related-reference-use. An alternate organizational reference to the case or file to which this particular claim pertains. |
related_reference_type_coding | String | The coding of the related-reference-type. An alternate organizational reference to the case or file to which this particular claim pertains. |
related_reference_type_text | String | The text of the related-reference-type. An alternate organizational reference to the case or file to which this particular claim pertains. |
related_reference_system | String | The related-reference-system of the related-reference-system. An alternate organizational reference to the case or file to which this particular claim pertains. |
related_reference_period_start | Datetime | The start of the related-reference-period. An alternate organizational reference to the case or file to which this particular claim pertains. |
related_reference_period_end | Datetime | The end of the related-reference-period. An alternate organizational reference to the case or file to which this particular claim pertains. |
prescription_display | String | The display of the prescription. Prescription to support the dispensing of pharmacy, device or vision products. |
prescription_reference | String | The reference of the prescription. Prescription to support the dispensing of pharmacy, device or vision products. |
prescription_identifier_value | String | The value of the prescription-identifier. Prescription to support the dispensing of pharmacy, device or vision products. |
prescription_type | String | The prescription-type of the prescription-type. Prescription to support the dispensing of pharmacy, device or vision products. |
originalPrescription_display | String | The display of the originalPrescription. Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. |
originalPrescription_reference | String | The reference of the originalPrescription. Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. |
originalPrescription_identifier_value | String | The value of the originalPrescription-identifier. Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. |
originalPrescription_type | String | The originalPrescription-type of the originalPrescription-type. Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. |
payee_id | String | The payee-id of the payee-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
payee_extension | String | The payee-extension of the payee-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
payee_modifierExtension | String | The payee-modifierExtension of the payee-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
payee_type_coding | String | The coding of the payee-type. Type of Party to be reimbursed: subscriber, provider, other. |
payee_type_text | String | The text of the payee-type. Type of Party to be reimbursed: subscriber, provider, other. |
payee_party_display | String | The display of the payee-party. Reference to the individual or organization to whom any payment will be made. |
payee_party_reference | String | The reference of the payee-party. Reference to the individual or organization to whom any payment will be made. |
payee_party_identifier_value | String | The value of the payee-party-identifier. Reference to the individual or organization to whom any payment will be made. |
payee_party_type | String | The payee-party-type of the payee-party-type. Reference to the individual or organization to whom any payment will be made. |
referral_display | String | The display of the referral. A reference to a referral resource. |
referral_reference | String | The reference of the referral. A reference to a referral resource. |
referral_identifier_value | String | The value of the referral-identifier. A reference to a referral resource. |
referral_type | String | The referral-type of the referral-type. A reference to a referral resource. |
facility_display | String | The display of the facility. Facility where the services were provided. |
facility_reference | String | The reference of the facility. Facility where the services were provided. |
facility_identifier_value | String | The value of the facility-identifier. Facility where the services were provided. |
facility_type | String | The facility-type of the facility-type. Facility where the services were provided. |
careTeam_id | String | The careTeam-id of the careTeam-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
careTeam_extension | String | The careTeam-extension of the careTeam-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
careTeam_modifierExtension | String | The careTeam-modifierExtension of the careTeam-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
careTeam_sequence | Int | The careTeam-sequence of the careTeam-sequence. A number to uniquely identify care team entries. |
careTeam_provider_display | String | The display of the careTeam-provider. Member of the team who provided the product or service. |
careTeam_provider_reference | String | The reference of the careTeam-provider. Member of the team who provided the product or service. |
careTeam_provider_identifier_value | String | The value of the careTeam-provider-identifier. Member of the team who provided the product or service. |
careTeam_provider_type | String | The careTeam-provider-type of the careTeam-provider-type. Member of the team who provided the product or service. |
careTeam_responsible | Bool | The careTeam-responsible of the careTeam-responsible. The party who is billing and/or responsible for the claimed products or services. |
careTeam_role_coding | String | The coding of the careTeam-role. The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. |
careTeam_role_text | String | The text of the careTeam-role. The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. |
careTeam_qualification_coding | String | The coding of the careTeam-qualification. The qualification of the practitioner which is applicable for this service. |
careTeam_qualification_text | String | The text of the careTeam-qualification. The qualification of the practitioner which is applicable for this service. |
supportingInfo_id | String | The supportingInfo-id of the supportingInfo-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
supportingInfo_extension | String | The supportingInfo-extension of the supportingInfo-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
supportingInfo_modifierExtension | String | The supportingInfo-modifierExtension of the supportingInfo-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
supportingInfo_sequence | Int | The supportingInfo-sequence of the supportingInfo-sequence. A number to uniquely identify supporting information entries. |
supportingInfo_category_coding | String | The coding of the supportingInfo-category. The general class of the information supplied: information; exception; accident, employment; onset, etc. |
supportingInfo_category_text | String | The text of the supportingInfo-category. The general class of the information supplied: information; exception; accident, employment; onset, etc. |
supportingInfo_code_coding | String | The coding of the supportingInfo-code. System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought. |
supportingInfo_code_text | String | The text of the supportingInfo-code. System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought. |
supportingInfo_timing_x_ | Date | The supportingInfo-timing[x] of the supportingInfo-timing[x]. The date when or period to which this information refers. |
supportingInfo_value_x_ | Bool | The supportingInfo-value[x] of the supportingInfo-value[x]. Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
supportingInfo_reason_coding | String | The coding of the supportingInfo-reason. Provides the reason in the situation where a reason code is required in addition to the content. |
supportingInfo_reason_text | String | The text of the supportingInfo-reason. Provides the reason in the situation where a reason code is required in addition to the content. |
diagnosis_id | String | The diagnosis-id of the diagnosis-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
diagnosis_extension | String | The diagnosis-extension of the diagnosis-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
diagnosis_modifierExtension | String | The diagnosis-modifierExtension of the diagnosis-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
diagnosis_sequence | Int | The diagnosis-sequence of the diagnosis-sequence. A number to uniquely identify diagnosis entries. |
diagnosis_diagnosis_x_coding | String | The coding of the diagnosis-diagnosis[x]. The nature of illness or problem in a coded form or as a reference to an external defined Condition. |
diagnosis_diagnosis_x_text | String | The text of the diagnosis-diagnosis[x]. The nature of illness or problem in a coded form or as a reference to an external defined Condition. |
diagnosis_type_coding | String | The coding of the diagnosis-type. When the condition was observed or the relative ranking. |
diagnosis_type_text | String | The text of the diagnosis-type. When the condition was observed or the relative ranking. |
diagnosis_onAdmission_coding | String | The coding of the diagnosis-onAdmission. Indication of whether the diagnosis was present on admission to a facility. |
diagnosis_onAdmission_text | String | The text of the diagnosis-onAdmission. Indication of whether the diagnosis was present on admission to a facility. |
diagnosis_packageCode_coding | String | The coding of the diagnosis-packageCode. A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system. |
diagnosis_packageCode_text | String | The text of the diagnosis-packageCode. A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system. |
procedure_id | String | The procedure-id of the procedure-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
procedure_extension | String | The procedure-extension of the procedure-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
procedure_modifierExtension | String | The procedure-modifierExtension of the procedure-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
procedure_sequence | Int | The procedure-sequence of the procedure-sequence. A number to uniquely identify procedure entries. |
procedure_type_coding | String | The coding of the procedure-type. When the condition was observed or the relative ranking. |
procedure_type_text | String | The text of the procedure-type. When the condition was observed or the relative ranking. |
procedure_date | Datetime | The procedure-date of the procedure-date. Date and optionally time the procedure was performed. |
procedure_procedure_x_coding | String | The coding of the procedure-procedure[x]. The code or reference to a Procedure resource which identifies the clinical intervention performed. |
procedure_procedure_x_text | String | The text of the procedure-procedure[x]. The code or reference to a Procedure resource which identifies the clinical intervention performed. |
procedure_udi_display | String | The display of the procedure-udi. Unique Device Identifiers associated with this line item. |
procedure_udi_reference | String | The reference of the procedure-udi. Unique Device Identifiers associated with this line item. |
procedure_udi_identifier_value | String | The value of the procedure-udi-identifier. Unique Device Identifiers associated with this line item. |
procedure_udi_type | String | The procedure-udi-type of the procedure-udi-type. Unique Device Identifiers associated with this line item. |
insurance_id | String | The insurance-id of the insurance-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
insurance_extension | String | The insurance-extension of the insurance-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
insurance_modifierExtension | String | The insurance-modifierExtension of the insurance-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
insurance_sequence | Int | The insurance-sequence of the insurance-sequence. A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order. |
insurance_focal | Bool | The insurance-focal of the insurance-focal. A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. |
insurance_identifier_value | String | The value of the insurance-identifier. The business identifier to be used when the claim is sent for adjudication against this insurance policy. |
insurance_identifier_use | String | The insurance-identifier-use of the insurance-identifier-use. The business identifier to be used when the claim is sent for adjudication against this insurance policy. |
insurance_identifier_type_coding | String | The coding of the insurance-identifier-type. The business identifier to be used when the claim is sent for adjudication against this insurance policy. |
insurance_identifier_type_text | String | The text of the insurance-identifier-type. The business identifier to be used when the claim is sent for adjudication against this insurance policy. |
insurance_identifier_system | String | The insurance-identifier-system of the insurance-identifier-system. The business identifier to be used when the claim is sent for adjudication against this insurance policy. |
insurance_identifier_period_start | Datetime | The start of the insurance-identifier-period. The business identifier to be used when the claim is sent for adjudication against this insurance policy. |
insurance_identifier_period_end | Datetime | The end of the insurance-identifier-period. The business identifier to be used when the claim is sent for adjudication against this insurance policy. |
insurance_coverage_display | String | The display of the insurance-coverage. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_coverage_reference | String | The reference of the insurance-coverage. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_coverage_identifier_value | String | The value of the insurance-coverage-identifier. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_coverage_type | String | The insurance-coverage-type of the insurance-coverage-type. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_businessArrangement | String | The insurance-businessArrangement of the insurance-businessArrangement. A business agreement number established between the provider and the insurer for special business processing purposes. |
insurance_preAuthRef | String | The insurance-preAuthRef of the insurance-preAuthRef. Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization. |
insurance_claimResponse_display | String | The display of the insurance-claimResponse. The result of the adjudication of the line items for the Coverage specified in this insurance. |
insurance_claimResponse_reference | String | The reference of the insurance-claimResponse. The result of the adjudication of the line items for the Coverage specified in this insurance. |
insurance_claimResponse_identifier_value | String | The value of the insurance-claimResponse-identifier. The result of the adjudication of the line items for the Coverage specified in this insurance. |
insurance_claimResponse_type | String | The insurance-claimResponse-type of the insurance-claimResponse-type. The result of the adjudication of the line items for the Coverage specified in this insurance. |
accident_id | String | The accident-id of the accident-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
accident_extension | String | The accident-extension of the accident-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
accident_modifierExtension | String | The accident-modifierExtension of the accident-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
accident_date | Date | The accident-date of the accident-date. Date of an accident event related to the products and services contained in the claim. |
accident_type_coding | String | The coding of the accident-type. The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers. |
accident_type_text | String | The text of the accident-type. The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers. |
accident_location_x_text | String | The text of the accident-location[x]. The physical location of the accident event. |
accident_location_x_line | String | The line of the accident-location[x]. The physical location of the accident event. |
accident_location_x_city | String | The city of the accident-location[x]. The physical location of the accident event. |
accident_location_x_district | String | The district of the accident-location[x]. The physical location of the accident event. |
accident_location_x_state | String | The state of the accident-location[x]. The physical location of the accident event. |
accident_location_x_postalCode | String | The postalCode of the accident-location[x]. The physical location of the accident event. |
accident_location_x_country | String | The country of the accident-location[x]. The physical location of the accident event. |
accident_location_x_type | String | The accident-location[x]-type of the accident-location[x]-type. The physical location of the accident event. |
accident_location_x_period_start | Datetime | The start of the accident-location[x]-period. The physical location of the accident event. |
accident_location_x_period_end | Datetime | The end of the accident-location[x]-period. The physical location of the accident event. |
accident_location_x_use | String | The accident-location[x]-use of the accident-location[x]-use. The physical location of the accident event. |
item_id | String | The item-id of the item-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_extension | String | The item-extension of the item-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_modifierExtension | String | The item-modifierExtension of the item-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_sequence | Int | The item-sequence of the item-sequence. A number to uniquely identify item entries. |
item_careTeamSequence | String | The item-careTeamSequence of the item-careTeamSequence. CareTeam members related to this service or product. |
item_diagnosisSequence | String | The item-diagnosisSequence of the item-diagnosisSequence. Diagnosis applicable for this service or product. |
item_procedureSequence | String | The item-procedureSequence of the item-procedureSequence. Procedures applicable for this service or product. |
item_informationSequence | String | The item-informationSequence of the item-informationSequence. Exceptions, special conditions and supporting information applicable for this service or product. |
item_revenue_coding | String | The coding of the item-revenue. The type of revenue or cost center providing the product and/or service. |
item_revenue_text | String | The text of the item-revenue. The type of revenue or cost center providing the product and/or service. |
item_category_coding | String | The coding of the item-category. Code to identify the general type of benefits under which products and services are provided. |
item_category_text | String | The text of the item-category. Code to identify the general type of benefits under which products and services are provided. |
item_productOrService_coding | String | The coding of the item-productOrService. When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
item_productOrService_text | String | The text of the item-productOrService. When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
item_modifier_coding | String | The coding of the item-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
item_modifier_text | String | The text of the item-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
item_programCode_coding | String | The coding of the item-programCode. Identifies the program under which this may be recovered. |
item_programCode_text | String | The text of the item-programCode. Identifies the program under which this may be recovered. |
item_serviced_x_ | Date | The item-serviced[x] of the item-serviced[x]. The date or dates when the service or product was supplied, performed or completed. |
item_location_x_coding | String | The coding of the item-location[x]. Where the product or service was provided. |
item_location_x_text | String | The text of the item-location[x]. Where the product or service was provided. |
item_quantity_value | Decimal | The value of the item-quantity. The number of repetitions of a service or product. |
item_quantity_unit | String | The unit of the item-quantity. The number of repetitions of a service or product. |
item_quantity_system | String | The system of the item-quantity. The number of repetitions of a service or product. |
item_quantity_comparator | String | The item-quantity-comparator of the item-quantity-comparator. The number of repetitions of a service or product. |
item_quantity_code | String | The item-quantity-code of the item-quantity-code. The number of repetitions of a service or product. |
item_unitPrice | String | The item-unitPrice of the item-unitPrice. If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. |
item_factor | Decimal | The item-factor of the item-factor. A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
item_net | String | The item-net of the item-net. The quantity times the unit price for an additional service or product or charge. |
item_udi_display | String | The display of the item-udi. Unique Device Identifiers associated with this line item. |
item_udi_reference | String | The reference of the item-udi. Unique Device Identifiers associated with this line item. |
item_udi_identifier_value | String | The value of the item-udi-identifier. Unique Device Identifiers associated with this line item. |
item_udi_type | String | The item-udi-type of the item-udi-type. Unique Device Identifiers associated with this line item. |
item_bodySite_coding | String | The coding of the item-bodySite. Physical service site on the patient (limb, tooth, etc.). |
item_bodySite_text | String | The text of the item-bodySite. Physical service site on the patient (limb, tooth, etc.). |
item_subSite_coding | String | The coding of the item-subSite. A region or surface of the bodySite, e.g. limb region or tooth surface(s). |
item_subSite_text | String | The text of the item-subSite. A region or surface of the bodySite, e.g. limb region or tooth surface(s). |
item_encounter_display | String | The display of the item-encounter. The Encounters during which this Claim was created or to which the creation of this record is tightly associated. |
item_encounter_reference | String | The reference of the item-encounter. The Encounters during which this Claim was created or to which the creation of this record is tightly associated. |
item_encounter_identifier_value | String | The value of the item-encounter-identifier. The Encounters during which this Claim was created or to which the creation of this record is tightly associated. |
item_encounter_type | String | The item-encounter-type of the item-encounter-type. The Encounters during which this Claim was created or to which the creation of this record is tightly associated. |
item_detail_id | String | The item-detail-id of the item-detail-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_detail_extension | String | The item-detail-extension of the item-detail-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_detail_modifierExtension | String | The item-detail-modifierExtension of the item-detail-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_detail_sequence | Int | The item-detail-sequence of the item-detail-sequence. A number to uniquely identify item entries. |
item_detail_revenue_coding | String | The coding of the item-detail-revenue. The type of revenue or cost center providing the product and/or service. |
item_detail_revenue_text | String | The text of the item-detail-revenue. The type of revenue or cost center providing the product and/or service. |
item_detail_category_coding | String | The coding of the item-detail-category. Code to identify the general type of benefits under which products and services are provided. |
item_detail_category_text | String | The text of the item-detail-category. Code to identify the general type of benefits under which products and services are provided. |
item_detail_productOrService_coding | String | The coding of the item-detail-productOrService. When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
item_detail_productOrService_text | String | The text of the item-detail-productOrService. When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
item_detail_modifier_coding | String | The coding of the item-detail-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
item_detail_modifier_text | String | The text of the item-detail-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
item_detail_programCode_coding | String | The coding of the item-detail-programCode. Identifies the program under which this may be recovered. |
item_detail_programCode_text | String | The text of the item-detail-programCode. Identifies the program under which this may be recovered. |
item_detail_quantity_value | Decimal | The value of the item-detail-quantity. The number of repetitions of a service or product. |
item_detail_quantity_unit | String | The unit of the item-detail-quantity. The number of repetitions of a service or product. |
item_detail_quantity_system | String | The system of the item-detail-quantity. The number of repetitions of a service or product. |
item_detail_quantity_comparator | String | The item-detail-quantity-comparator of the item-detail-quantity-comparator. The number of repetitions of a service or product. |
item_detail_quantity_code | String | The item-detail-quantity-code of the item-detail-quantity-code. The number of repetitions of a service or product. |
item_detail_unitPrice | String | The item-detail-unitPrice of the item-detail-unitPrice. If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. |
item_detail_factor | Decimal | The item-detail-factor of the item-detail-factor. A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
item_detail_net | String | The item-detail-net of the item-detail-net. The quantity times the unit price for an additional service or product or charge. |
item_detail_udi_display | String | The display of the item-detail-udi. Unique Device Identifiers associated with this line item. |
item_detail_udi_reference | String | The reference of the item-detail-udi. Unique Device Identifiers associated with this line item. |
item_detail_udi_identifier_value | String | The value of the item-detail-udi-identifier. Unique Device Identifiers associated with this line item. |
item_detail_udi_type | String | The item-detail-udi-type of the item-detail-udi-type. Unique Device Identifiers associated with this line item. |
item_detail_subDetail_id | String | The item-detail-subDetail-id of the item-detail-subDetail-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_detail_subDetail_extension | String | The item-detail-subDetail-extension of the item-detail-subDetail-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_detail_subDetail_modifierExtension | String | The item-detail-subDetail-modifierExtension of the item-detail-subDetail-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_detail_subDetail_sequence | Int | The item-detail-subDetail-sequence of the item-detail-subDetail-sequence. A number to uniquely identify item entries. |
item_detail_subDetail_revenue_coding | String | The coding of the item-detail-subDetail-revenue. The type of revenue or cost center providing the product and/or service. |
item_detail_subDetail_revenue_text | String | The text of the item-detail-subDetail-revenue. The type of revenue or cost center providing the product and/or service. |
item_detail_subDetail_category_coding | String | The coding of the item-detail-subDetail-category. Code to identify the general type of benefits under which products and services are provided. |
item_detail_subDetail_category_text | String | The text of the item-detail-subDetail-category. Code to identify the general type of benefits under which products and services are provided. |
item_detail_subDetail_productOrService_coding | String | The coding of the item-detail-subDetail-productOrService. When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
item_detail_subDetail_productOrService_text | String | The text of the item-detail-subDetail-productOrService. When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
item_detail_subDetail_modifier_coding | String | The coding of the item-detail-subDetail-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
item_detail_subDetail_modifier_text | String | The text of the item-detail-subDetail-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
item_detail_subDetail_programCode_coding | String | The coding of the item-detail-subDetail-programCode. Identifies the program under which this may be recovered. |
item_detail_subDetail_programCode_text | String | The text of the item-detail-subDetail-programCode. Identifies the program under which this may be recovered. |
item_detail_subDetail_quantity_value | Decimal | The value of the item-detail-subDetail-quantity. The number of repetitions of a service or product. |
item_detail_subDetail_quantity_unit | String | The unit of the item-detail-subDetail-quantity. The number of repetitions of a service or product. |
item_detail_subDetail_quantity_system | String | The system of the item-detail-subDetail-quantity. The number of repetitions of a service or product. |
item_detail_subDetail_quantity_comparator | String | The item-detail-subDetail-quantity-comparator of the item-detail-subDetail-quantity-comparator. The number of repetitions of a service or product. |
item_detail_subDetail_quantity_code | String | The item-detail-subDetail-quantity-code of the item-detail-subDetail-quantity-code. The number of repetitions of a service or product. |
item_detail_subDetail_unitPrice | String | The item-detail-subDetail-unitPrice of the item-detail-subDetail-unitPrice. If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. |
item_detail_subDetail_factor | Decimal | The item-detail-subDetail-factor of the item-detail-subDetail-factor. A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
item_detail_subDetail_net | String | The item-detail-subDetail-net of the item-detail-subDetail-net. The quantity times the unit price for an additional service or product or charge. |
item_detail_subDetail_udi_display | String | The display of the item-detail-subDetail-udi. Unique Device Identifiers associated with this line item. |
item_detail_subDetail_udi_reference | String | The reference of the item-detail-subDetail-udi. Unique Device Identifiers associated with this line item. |
item_detail_subDetail_udi_identifier_value | String | The value of the item-detail-subDetail-udi-identifier. Unique Device Identifiers associated with this line item. |
item_detail_subDetail_udi_type | String | The item-detail-subDetail-udi-type of the item-detail-subDetail-udi-type. Unique Device Identifiers associated with this line item. |
total | String | The total value of the all the items in the claim. |
SP_source | String | The SP_source search parameter. |
SP_facility | String | The SP_facility search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_procedure_udi | String | The SP_procedure_udi search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_detail_udi | String | The SP_detail_udi search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_enterer | String | The SP_enterer search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_insurer | String | The SP_insurer search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_care_team | String | The SP_care_team search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_payee | String | The SP_payee search parameter. |
SP_subdetail_udi | String | The SP_subdetail_udi search parameter. |
SP_item_udi | String | The SP_item_udi search parameter. |
SP_priority_end | String | The SP_priority_end search parameter. |
SP_priority_start | String | The SP_priority_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_provider | String | The SP_provider search parameter. |
ClaimResponse view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique identifier assigned to this claim response. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this claim response. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this claim response. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this claim response. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this claim response. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this claim response. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this claim response. |
status | String | The status of the resource instance. |
type_coding | String | The coding of the type. A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. |
type_text | String | The text of the type. A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. |
subType_coding | String | The coding of the subType. A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. |
subType_text | String | The text of the subType. A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. |
use | String | A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future. |
patient_display | String | The display of the patient. The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought. |
patient_reference | String | The reference of the patient. The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought. |
patient_identifier_value | String | The value of the patient-identifier. The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought. |
patient_type | String | The patient-type of the patient-type. The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought. |
created | Datetime | The date this resource was created. |
insurer_display | String | The display of the insurer. The party responsible for authorization, adjudication and reimbursement. |
insurer_reference | String | The reference of the insurer. The party responsible for authorization, adjudication and reimbursement. |
insurer_identifier_value | String | The value of the insurer-identifier. The party responsible for authorization, adjudication and reimbursement. |
insurer_type | String | The insurer-type of the insurer-type. The party responsible for authorization, adjudication and reimbursement. |
requestor_display | String | The display of the requestor. The provider which is responsible for the claim, predetermination or preauthorization. |
requestor_reference | String | The reference of the requestor. The provider which is responsible for the claim, predetermination or preauthorization. |
requestor_identifier_value | String | The value of the requestor-identifier. The provider which is responsible for the claim, predetermination or preauthorization. |
requestor_type | String | The requestor-type of the requestor-type. The provider which is responsible for the claim, predetermination or preauthorization. |
request_display | String | The display of the request. Original request resource reference. |
request_reference | String | The reference of the request. Original request resource reference. |
request_identifier_value | String | The value of the request-identifier. Original request resource reference. |
request_type | String | The request-type of the request-type. Original request resource reference. |
outcome | String | The outcome of the claim, predetermination, or preauthorization processing. |
disposition | String | A human readable description of the status of the adjudication. |
preAuthRef | String | Reference from the Insurer which is used in later communications which refers to this adjudication. |
preAuthPeriod_start | Datetime | The start of the preAuthPeriod. The time frame during which this authorization is effective. |
preAuthPeriod_end | Datetime | The end of the preAuthPeriod. The time frame during which this authorization is effective. |
payeeType_coding | String | The coding of the payeeType. Type of Party to be reimbursed: subscriber, provider, other. |
payeeType_text | String | The text of the payeeType. Type of Party to be reimbursed: subscriber, provider, other. |
item_id | String | The item-id of the item-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_extension | String | The item-extension of the item-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_modifierExtension | String | The item-modifierExtension of the item-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_itemSequence | Int | The item-itemSequence of the item-itemSequence. A number to uniquely reference the claim item entries. |
item_noteNumber | String | The item-noteNumber of the item-noteNumber. The numbers associated with notes below which apply to the adjudication of this item. |
item_adjudication_id | String | The item-adjudication-id of the item-adjudication-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_adjudication_extension | String | The item-adjudication-extension of the item-adjudication-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_adjudication_modifierExtension | String | The item-adjudication-modifierExtension of the item-adjudication-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_adjudication_category_coding | String | The coding of the item-adjudication-category. A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item. |
item_adjudication_category_text | String | The text of the item-adjudication-category. A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item. |
item_adjudication_reason_coding | String | The coding of the item-adjudication-reason. A code supporting the understanding of the adjudication result and explaining variance from expected amount. |
item_adjudication_reason_text | String | The text of the item-adjudication-reason. A code supporting the understanding of the adjudication result and explaining variance from expected amount. |
item_adjudication_amount | String | The item-adjudication-amount of the item-adjudication-amount. Monetary amount associated with the category. |
item_adjudication_value | Decimal | The item-adjudication-value of the item-adjudication-value. A non-monetary value associated with the category. Mutually exclusive to the amount element above. |
item_detail_id | String | The item-detail-id of the item-detail-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_detail_extension | String | The item-detail-extension of the item-detail-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_detail_modifierExtension | String | The item-detail-modifierExtension of the item-detail-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_detail_detailSequence | Int | The item-detail-detailSequence of the item-detail-detailSequence. A number to uniquely reference the claim detail entry. |
item_detail_noteNumber | String | The item-detail-noteNumber of the item-detail-noteNumber. The numbers associated with notes below which apply to the adjudication of this item. |
SP_source | String | The SP_source search parameter. |
SP_payment_date | String | The SP_payment_date search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_request | String | The SP_request search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_requestor | String | The SP_requestor search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_insurer | String | The SP_insurer search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
ClinicalImpression view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
status | String | Identifies the workflow status of the assessment. |
statusReason_coding | String | The coding of the statusReason. Captures the reason for the current state of the ClinicalImpression. |
statusReason_text | String | The text of the statusReason. Captures the reason for the current state of the ClinicalImpression. |
code_coding | String | The coding of the code. Categorizes the type of clinical assessment performed. |
code_text | String | The text of the code. Categorizes the type of clinical assessment performed. |
description | String | A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it. |
subject_display | String | The display of the subject. The patient or group of individuals assessed as part of this record. |
subject_reference | String | The reference of the subject. The patient or group of individuals assessed as part of this record. |
subject_identifier_value | String | The value of the subject-identifier. The patient or group of individuals assessed as part of this record. |
subject_type | String | The subject-type of the subject-type. The patient or group of individuals assessed as part of this record. |
encounter_display | String | The display of the encounter. The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated. |
encounter_reference | String | The reference of the encounter. The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated. |
encounter_identifier_value | String | The value of the encounter-identifier. The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated. |
encounter_type | String | The encounter-type of the encounter-type. The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated. |
effective_x_ | Datetime | The point in time or period over which the subject was assessed. |
date | Datetime | Indicates when the documentation of the assessment was complete. |
assessor_display | String | The display of the assessor. The clinician performing the assessment. |
assessor_reference | String | The reference of the assessor. The clinician performing the assessment. |
assessor_identifier_value | String | The value of the assessor-identifier. The clinician performing the assessment. |
assessor_type | String | The assessor-type of the assessor-type. The clinician performing the assessment. |
previous_display | String | The display of the previous. A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes. |
previous_reference | String | The reference of the previous. A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes. |
previous_identifier_value | String | The value of the previous-identifier. A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes. |
previous_type | String | The previous-type of the previous-type. A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes. |
problem_display | String | The display of the problem. A list of the relevant problems/conditions for a patient. |
problem_reference | String | The reference of the problem. A list of the relevant problems/conditions for a patient. |
problem_identifier_value | String | The value of the problem-identifier. A list of the relevant problems/conditions for a patient. |
problem_type | String | The problem-type of the problem-type. A list of the relevant problems/conditions for a patient. |
investigation_id | String | The investigation-id of the investigation-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
investigation_extension | String | The investigation-extension of the investigation-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
investigation_modifierExtension | String | The investigation-modifierExtension of the investigation-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
investigation_code_coding | String | The coding of the investigation-code. A name/code for the group ('set') of investigations. Typically, this will be something like 'signs', 'symptoms', 'clinical', 'diagnostic', but the list is not constrained, and others such groups such as (exposure|family|travel|nutritional) history may be used. |
investigation_code_text | String | The text of the investigation-code. A name/code for the group ('set') of investigations. Typically, this will be something like 'signs', 'symptoms', 'clinical', 'diagnostic', but the list is not constrained, and others such groups such as (exposure|family|travel|nutritional) history may be used. |
investigation_item_display | String | The display of the investigation-item. A record of a specific investigation that was undertaken. |
investigation_item_reference | String | The reference of the investigation-item. A record of a specific investigation that was undertaken. |
investigation_item_identifier_value | String | The value of the investigation-item-identifier. A record of a specific investigation that was undertaken. |
investigation_item_type | String | The investigation-item-type of the investigation-item-type. A record of a specific investigation that was undertaken. |
protocol | String | Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis. |
summary | String | A text summary of the investigations and the diagnosis. |
finding_id | String | The finding-id of the finding-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
finding_extension | String | The finding-extension of the finding-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
finding_modifierExtension | String | The finding-modifierExtension of the finding-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
finding_itemCodeableConcept_coding | String | The coding of the finding-itemCodeableConcept. Specific text or code for finding or diagnosis, which may include ruled-out or resolved conditions. |
finding_itemCodeableConcept_text | String | The text of the finding-itemCodeableConcept. Specific text or code for finding or diagnosis, which may include ruled-out or resolved conditions. |
finding_itemReference_display | String | The display of the finding-itemReference. Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions. |
finding_itemReference_reference | String | The reference of the finding-itemReference. Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions. |
finding_itemReference_identifier_value | String | The value of the finding-itemReference-identifier. Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions. |
finding_itemReference_type | String | The finding-itemReference-type of the finding-itemReference-type. Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions. |
finding_basis | String | The finding-basis of the finding-basis. Which investigations support finding or diagnosis. |
prognosisCodeableConcept_coding | String | The coding of the prognosisCodeableConcept. Estimate of likely outcome. |
prognosisCodeableConcept_text | String | The text of the prognosisCodeableConcept. Estimate of likely outcome. |
prognosisReference_display | String | The display of the prognosisReference. RiskAssessment expressing likely outcome. |
prognosisReference_reference | String | The reference of the prognosisReference. RiskAssessment expressing likely outcome. |
prognosisReference_identifier_value | String | The value of the prognosisReference-identifier. RiskAssessment expressing likely outcome. |
prognosisReference_type | String | The prognosisReference-type of the prognosisReference-type. RiskAssessment expressing likely outcome. |
supportingInfo_display | String | The display of the supportingInfo. Information supporting the clinical impression. |
supportingInfo_reference | String | The reference of the supportingInfo. Information supporting the clinical impression. |
supportingInfo_identifier_value | String | The value of the supportingInfo-identifier. Information supporting the clinical impression. |
supportingInfo_type | String | The supportingInfo-type of the supportingInfo-type. Information supporting the clinical impression. |
note | String | Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear. |
SP_source | String | The SP_source search parameter. |
SP_finding_code_start | String | The SP_finding_code_start search parameter. |
SP_assessor | String | The SP_assessor search parameter. |
SP_text | String | The SP_text search parameter. |
SP_previous | String | The SP_previous search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_finding_ref | String | The SP_finding_ref search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_finding_code_end | String | The SP_finding_code_end search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_investigation | String | The SP_investigation search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_problem | String | The SP_problem search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_supporting_info | String | The SP_supporting_info search parameter. |
SP_filter | String | The SP_filter search parameter. |
ClinicalUseDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifier for this issue. |
identifier_use | String | The identifier-use of the identifier-use. Business identifier for this issue. |
identifier_type_coding | String | The coding of the identifier-type. Business identifier for this issue. |
identifier_type_text | String | The text of the identifier-type. Business identifier for this issue. |
identifier_system | String | The identifier-system of the identifier-system. Business identifier for this issue. |
identifier_period_start | String | The start of the identifier-period. Business identifier for this issue. |
identifier_period_end | String | The end of the identifier-period. Business identifier for this issue. |
type | String | indication | contraindication | interaction | undesirable-effect | warning. |
category_coding | String | The coding of the category. A categorisation of the issue, primarily for dividing warnings into subject heading areas such as 'Pregnancy and Lactation', 'Overdose', 'Effects on Ability to Drive and Use Machines'. |
category_text | String | The text of the category. A categorisation of the issue, primarily for dividing warnings into subject heading areas such as 'Pregnancy and Lactation', 'Overdose', 'Effects on Ability to Drive and Use Machines'. |
subject_display | String | The display of the subject. The medication or procedure for which this is an indication. |
subject_reference | String | The reference of the subject. The medication or procedure for which this is an indication. |
subject_identifier_value | String | The value of the subject-identifier. The medication or procedure for which this is an indication. |
subject_type | String | The subject-type of the subject-type. The medication or procedure for which this is an indication. |
status_coding | String | The coding of the status. Whether this is a current issue or one that has been retired etc. |
status_text | String | The text of the status. Whether this is a current issue or one that has been retired etc. |
contraindication_id | String | The contraindication-id of the contraindication-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
contraindication_extension | String | The contraindication-extension of the contraindication-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
contraindication_modifierExtension | String | The contraindication-modifierExtension of the contraindication-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
contraindication_diseaseSymptomProcedure_display | String | The display of the contraindication-diseaseSymptomProcedure. The situation that is being documented as contraindicating against this item. |
contraindication_diseaseSymptomProcedure_reference | String | The reference of the contraindication-diseaseSymptomProcedure. The situation that is being documented as contraindicating against this item. |
contraindication_diseaseSymptomProcedure_identifier_value | String | The value of the contraindication-diseaseSymptomProcedure-identifier. The situation that is being documented as contraindicating against this item. |
contraindication_diseaseSymptomProcedure_type | String | The contraindication-diseaseSymptomProcedure-type of the contraindication-diseaseSymptomProcedure-type. The situation that is being documented as contraindicating against this item. |
contraindication_diseaseStatus_display | String | The display of the contraindication-diseaseStatus. The status of the disease or symptom for the contraindication. |
contraindication_diseaseStatus_reference | String | The reference of the contraindication-diseaseStatus. The status of the disease or symptom for the contraindication. |
contraindication_diseaseStatus_identifier_value | String | The value of the contraindication-diseaseStatus-identifier. The status of the disease or symptom for the contraindication. |
contraindication_diseaseStatus_type | String | The contraindication-diseaseStatus-type of the contraindication-diseaseStatus-type. The status of the disease or symptom for the contraindication. |
contraindication_comorbidity_display | String | The display of the contraindication-comorbidity. A comorbidity (concurrent condition) or coinfection. |
contraindication_comorbidity_reference | String | The reference of the contraindication-comorbidity. A comorbidity (concurrent condition) or coinfection. |
contraindication_comorbidity_identifier_value | String | The value of the contraindication-comorbidity-identifier. A comorbidity (concurrent condition) or coinfection. |
contraindication_comorbidity_type | String | The contraindication-comorbidity-type of the contraindication-comorbidity-type. A comorbidity (concurrent condition) or coinfection. |
contraindication_indication_display | String | The display of the contraindication-indication. The indication which this is a contraidication for. |
contraindication_indication_reference | String | The reference of the contraindication-indication. The indication which this is a contraidication for. |
contraindication_indication_identifier_value | String | The value of the contraindication-indication-identifier. The indication which this is a contraidication for. |
contraindication_indication_type | String | The contraindication-indication-type of the contraindication-indication-type. The indication which this is a contraidication for. |
contraindication_otherTherapy_id | String | The contraindication-otherTherapy-id of the contraindication-otherTherapy-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
contraindication_otherTherapy_extension | String | The contraindication-otherTherapy-extension of the contraindication-otherTherapy-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
contraindication_otherTherapy_modifierExtension | String | The contraindication-otherTherapy-modifierExtension of the contraindication-otherTherapy-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
contraindication_otherTherapy_relationshipType_coding | String | The coding of the contraindication-otherTherapy-relationshipType. The type of relationship between the medicinal product indication or contraindication and another therapy. |
contraindication_otherTherapy_relationshipType_text | String | The text of the contraindication-otherTherapy-relationshipType. The type of relationship between the medicinal product indication or contraindication and another therapy. |
contraindication_otherTherapy_therapy_display | String | The display of the contraindication-otherTherapy-therapy. Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication. |
contraindication_otherTherapy_therapy_reference | String | The reference of the contraindication-otherTherapy-therapy. Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication. |
contraindication_otherTherapy_therapy_identifier_value | String | The value of the contraindication-otherTherapy-therapy-identifier. Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication. |
contraindication_otherTherapy_therapy_type | String | The contraindication-otherTherapy-therapy-type of the contraindication-otherTherapy-therapy-type. Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication. |
indication_id | String | The indication-id of the indication-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
indication_extension | String | The indication-extension of the indication-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
indication_modifierExtension | String | The indication-modifierExtension of the indication-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
indication_diseaseSymptomProcedure_display | String | The display of the indication-diseaseSymptomProcedure. The situation that is being documented as an indicaton for this item. |
indication_diseaseSymptomProcedure_reference | String | The reference of the indication-diseaseSymptomProcedure. The situation that is being documented as an indicaton for this item. |
indication_diseaseSymptomProcedure_identifier_value | String | The value of the indication-diseaseSymptomProcedure-identifier. The situation that is being documented as an indicaton for this item. |
indication_diseaseSymptomProcedure_type | String | The indication-diseaseSymptomProcedure-type of the indication-diseaseSymptomProcedure-type. The situation that is being documented as an indicaton for this item. |
indication_diseaseStatus_display | String | The display of the indication-diseaseStatus. The status of the disease or symptom for the indication. |
indication_diseaseStatus_reference | String | The reference of the indication-diseaseStatus. The status of the disease or symptom for the indication. |
indication_diseaseStatus_identifier_value | String | The value of the indication-diseaseStatus-identifier. The status of the disease or symptom for the indication. |
indication_diseaseStatus_type | String | The indication-diseaseStatus-type of the indication-diseaseStatus-type. The status of the disease or symptom for the indication. |
indication_comorbidity_display | String | The display of the indication-comorbidity. A comorbidity (concurrent condition) or coinfection as part of the indication. |
indication_comorbidity_reference | String | The reference of the indication-comorbidity. A comorbidity (concurrent condition) or coinfection as part of the indication. |
indication_comorbidity_identifier_value | String | The value of the indication-comorbidity-identifier. A comorbidity (concurrent condition) or coinfection as part of the indication. |
indication_comorbidity_type | String | The indication-comorbidity-type of the indication-comorbidity-type. A comorbidity (concurrent condition) or coinfection as part of the indication. |
indication_intendedEffect_display | String | The display of the indication-intendedEffect. The intended effect, aim or strategy to be achieved. |
indication_intendedEffect_reference | String | The reference of the indication-intendedEffect. The intended effect, aim or strategy to be achieved. |
indication_intendedEffect_identifier_value | String | The value of the indication-intendedEffect-identifier. The intended effect, aim or strategy to be achieved. |
indication_intendedEffect_type | String | The indication-intendedEffect-type of the indication-intendedEffect-type. The intended effect, aim or strategy to be achieved. |
indication_duration_value | Decimal | The value of the indication-duration. Timing or duration information. |
indication_duration_unit | String | The unit of the indication-duration. Timing or duration information. |
indication_duration_system | String | The system of the indication-duration. Timing or duration information. |
indication_duration_comparator | String | The indication-duration-comparator of the indication-duration-comparator. Timing or duration information. |
indication_duration_code | String | The indication-duration-code of the indication-duration-code. Timing or duration information. |
indication_undesirableEffect_display | String | The display of the indication-undesirableEffect. The specific undesirable effects of the medicinal product. |
indication_undesirableEffect_reference | String | The reference of the indication-undesirableEffect. The specific undesirable effects of the medicinal product. |
indication_undesirableEffect_identifier_value | String | The value of the indication-undesirableEffect-identifier. The specific undesirable effects of the medicinal product. |
indication_undesirableEffect_type | String | The indication-undesirableEffect-type of the indication-undesirableEffect-type. The specific undesirable effects of the medicinal product. |
SP_interaction_start | String | The SP_interaction_start search parameter. |
SP_source | String | The SP_source search parameter. |
SP_product | String | The SP_product search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_indication_reference | String | The SP_indication_reference search parameter. |
SP_effect_end | String | The SP_effect_end search parameter. |
SP_contraindication_reference | String | The SP_contraindication_reference search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_effect_reference | String | The SP_effect_reference search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_effect_start | String | The SP_effect_start search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_contraindication_start | String | The SP_contraindication_start search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_indication_start | String | The SP_indication_start search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_indication_end | String | The SP_indication_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_interaction_end | String | The SP_interaction_end search parameter. |
SP_contraindication_end | String | The SP_contraindication_end search parameter. |
Communication view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
instantiatesCanonical | String | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication. |
instantiatesUri | String | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication. |
basedOn_display | String | The display of the basedOn. An order, proposal or plan fulfilled in whole or in part by this Communication. |
basedOn_reference | String | The reference of the basedOn. An order, proposal or plan fulfilled in whole or in part by this Communication. |
basedOn_identifier_value | String | The value of the basedOn-identifier. An order, proposal or plan fulfilled in whole or in part by this Communication. |
basedOn_type | String | The basedOn-type of the basedOn-type. An order, proposal or plan fulfilled in whole or in part by this Communication. |
partOf_display | String | The display of the partOf. Part of this action. |
partOf_reference | String | The reference of the partOf. Part of this action. |
partOf_identifier_value | String | The value of the partOf-identifier. Part of this action. |
partOf_type | String | The partOf-type of the partOf-type. Part of this action. |
inResponseTo_display | String | The display of the inResponseTo. Prior communication that this communication is in response to. |
inResponseTo_reference | String | The reference of the inResponseTo. Prior communication that this communication is in response to. |
inResponseTo_identifier_value | String | The value of the inResponseTo-identifier. Prior communication that this communication is in response to. |
inResponseTo_type | String | The inResponseTo-type of the inResponseTo-type. Prior communication that this communication is in response to. |
status | String | The status of the transmission. |
statusReason_coding | String | The coding of the statusReason. Captures the reason for the current state of the Communication. |
statusReason_text | String | The text of the statusReason. Captures the reason for the current state of the Communication. |
category_coding | String | The coding of the category. The type of message conveyed such as alert, notification, reminder, instruction, etc. |
category_text | String | The text of the category. The type of message conveyed such as alert, notification, reminder, instruction, etc. |
priority | String | Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine. |
medium_coding | String | The coding of the medium. A channel that was used for this communication (e.g. email, fax). |
medium_text | String | The text of the medium. A channel that was used for this communication (e.g. email, fax). |
subject_display | String | The display of the subject. The patient or group that was the focus of this communication. |
subject_reference | String | The reference of the subject. The patient or group that was the focus of this communication. |
subject_identifier_value | String | The value of the subject-identifier. The patient or group that was the focus of this communication. |
subject_type | String | The subject-type of the subject-type. The patient or group that was the focus of this communication. |
topic_coding | String | The coding of the topic. Description of the purpose/content, similar to a subject line in an email. |
topic_text | String | The text of the topic. Description of the purpose/content, similar to a subject line in an email. |
about_display | String | The display of the about. Other resources that pertain to this communication and to which this communication should be associated. |
about_reference | String | The reference of the about. Other resources that pertain to this communication and to which this communication should be associated. |
about_identifier_value | String | The value of the about-identifier. Other resources that pertain to this communication and to which this communication should be associated. |
about_type | String | The about-type of the about-type. Other resources that pertain to this communication and to which this communication should be associated. |
encounter_display | String | The display of the encounter. The Encounter during which this Communication was created or to which the creation of this record is tightly associated. |
encounter_reference | String | The reference of the encounter. The Encounter during which this Communication was created or to which the creation of this record is tightly associated. |
encounter_identifier_value | String | The value of the encounter-identifier. The Encounter during which this Communication was created or to which the creation of this record is tightly associated. |
encounter_type | String | The encounter-type of the encounter-type. The Encounter during which this Communication was created or to which the creation of this record is tightly associated. |
sent | Datetime | The time when this communication was sent. |
received | Datetime | The time when this communication arrived at the destination. |
recipient_display | String | The display of the recipient. The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time). |
recipient_reference | String | The reference of the recipient. The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time). |
recipient_identifier_value | String | The value of the recipient-identifier. The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time). |
recipient_type | String | The recipient-type of the recipient-type. The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time). |
sender_display | String | The display of the sender. The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. |
sender_reference | String | The reference of the sender. The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. |
sender_identifier_value | String | The value of the sender-identifier. The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. |
sender_type | String | The sender-type of the sender-type. The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. |
reasonCode_coding | String | The coding of the reasonCode. The reason or justification for the communication. |
reasonCode_text | String | The text of the reasonCode. The reason or justification for the communication. |
reasonReference_display | String | The display of the reasonReference. Indicates another resource whose existence justifies this communication. |
reasonReference_reference | String | The reference of the reasonReference. Indicates another resource whose existence justifies this communication. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Indicates another resource whose existence justifies this communication. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Indicates another resource whose existence justifies this communication. |
payload_id | String | The payload-id of the payload-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
payload_extension | String | The payload-extension of the payload-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
payload_modifierExtension | String | The payload-modifierExtension of the payload-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
payload_content_x_ | String | The payload-content[x] of the payload-content[x]. A communicated content (or for multi-part communications, one portion of the communication). |
note | String | Additional notes or commentary about the communication by the sender, receiver or other interested parties. |
SP_source | String | The SP_source search parameter. |
SP_sender | String | The SP_sender search parameter. |
SP_instantiates_canonical | String | The SP_instantiates_canonical search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_recipient | String | The SP_recipient search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_instantiates_uri | String | The SP_instantiates_uri search parameter. |
SP_based_on | String | The SP_based_on search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_part_of | String | The SP_part_of search parameter. |
SP_medium_end | String | The SP_medium_end search parameter. |
SP_medium_start | String | The SP_medium_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
CommunicationRequest view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
basedOn_display | String | The display of the basedOn. A plan or proposal that is fulfilled in whole or in part by this request. |
basedOn_reference | String | The reference of the basedOn. A plan or proposal that is fulfilled in whole or in part by this request. |
basedOn_identifier_value | String | The value of the basedOn-identifier. A plan or proposal that is fulfilled in whole or in part by this request. |
basedOn_type | String | The basedOn-type of the basedOn-type. A plan or proposal that is fulfilled in whole or in part by this request. |
replaces_display | String | The display of the replaces. Completed or terminated request(s) whose function is taken by this new request. |
replaces_reference | String | The reference of the replaces. Completed or terminated request(s) whose function is taken by this new request. |
replaces_identifier_value | String | The value of the replaces-identifier. Completed or terminated request(s) whose function is taken by this new request. |
replaces_type | String | The replaces-type of the replaces-type. Completed or terminated request(s) whose function is taken by this new request. |
groupIdentifier_value | String | The value of the groupIdentifier. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
groupIdentifier_use | String | The groupIdentifier-use of the groupIdentifier-use. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
groupIdentifier_type_coding | String | The coding of the groupIdentifier-type. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
groupIdentifier_type_text | String | The text of the groupIdentifier-type. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
groupIdentifier_system | String | The groupIdentifier-system of the groupIdentifier-system. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
groupIdentifier_period_start | Datetime | The start of the groupIdentifier-period. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
groupIdentifier_period_end | Datetime | The end of the groupIdentifier-period. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
status | String | The status of the proposal or order. |
statusReason_coding | String | The coding of the statusReason. Captures the reason for the current state of the CommunicationRequest. |
statusReason_text | String | The text of the statusReason. Captures the reason for the current state of the CommunicationRequest. |
category_coding | String | The coding of the category. The type of message to be sent such as alert, notification, reminder, instruction, etc. |
category_text | String | The text of the category. The type of message to be sent such as alert, notification, reminder, instruction, etc. |
priority | String | Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. |
doNotPerform | Bool | If true indicates that the CommunicationRequest is asking for the specified action to *not* occur. |
medium_coding | String | The coding of the medium. A channel that was used for this communication (e.g. email, fax). |
medium_text | String | The text of the medium. A channel that was used for this communication (e.g. email, fax). |
subject_display | String | The display of the subject. The patient or group that is the focus of this communication request. |
subject_reference | String | The reference of the subject. The patient or group that is the focus of this communication request. |
subject_identifier_value | String | The value of the subject-identifier. The patient or group that is the focus of this communication request. |
subject_type | String | The subject-type of the subject-type. The patient or group that is the focus of this communication request. |
about_display | String | The display of the about. Other resources that pertain to this communication request and to which this communication request should be associated. |
about_reference | String | The reference of the about. Other resources that pertain to this communication request and to which this communication request should be associated. |
about_identifier_value | String | The value of the about-identifier. Other resources that pertain to this communication request and to which this communication request should be associated. |
about_type | String | The about-type of the about-type. Other resources that pertain to this communication request and to which this communication request should be associated. |
encounter_display | String | The display of the encounter. The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated. |
encounter_reference | String | The reference of the encounter. The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated. |
encounter_identifier_value | String | The value of the encounter-identifier. The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated. |
encounter_type | String | The encounter-type of the encounter-type. The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated. |
payload_id | String | The payload-id of the payload-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
payload_extension | String | The payload-extension of the payload-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
payload_modifierExtension | String | The payload-modifierExtension of the payload-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
payload_content_x_ | String | The payload-content[x] of the payload-content[x]. The communicated content (or for multi-part communications, one portion of the communication). |
occurrence_x_ | Datetime | The time when this communication is to occur. |
authoredOn | Datetime | For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation. |
requester_display | String | The display of the requester. The device, individual, or organization who initiated the request and has responsibility for its activation. |
requester_reference | String | The reference of the requester. The device, individual, or organization who initiated the request and has responsibility for its activation. |
requester_identifier_value | String | The value of the requester-identifier. The device, individual, or organization who initiated the request and has responsibility for its activation. |
requester_type | String | The requester-type of the requester-type. The device, individual, or organization who initiated the request and has responsibility for its activation. |
recipient_display | String | The display of the recipient. The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication. |
recipient_reference | String | The reference of the recipient. The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication. |
recipient_identifier_value | String | The value of the recipient-identifier. The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication. |
recipient_type | String | The recipient-type of the recipient-type. The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication. |
sender_display | String | The display of the sender. The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. |
sender_reference | String | The reference of the sender. The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. |
sender_identifier_value | String | The value of the sender-identifier. The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. |
sender_type | String | The sender-type of the sender-type. The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. |
reasonCode_coding | String | The coding of the reasonCode. Describes why the request is being made in coded or textual form. |
reasonCode_text | String | The text of the reasonCode. Describes why the request is being made in coded or textual form. |
reasonReference_display | String | The display of the reasonReference. Indicates another resource whose existence justifies this request. |
reasonReference_reference | String | The reference of the reasonReference. Indicates another resource whose existence justifies this request. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Indicates another resource whose existence justifies this request. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Indicates another resource whose existence justifies this request. |
note | String | Comments made about the request by the requester, sender, recipient, subject or other participants. |
SP_source | String | The SP_source search parameter. |
SP_sender | String | The SP_sender search parameter. |
SP_text | String | The SP_text search parameter. |
SP_authored | String | The SP_authored search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_occurrence | String | The SP_occurrence search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_recipient | String | The SP_recipient search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_based_on | String | The SP_based_on search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_group_identifier_end | String | The SP_group_identifier_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_group_identifier_start | String | The SP_group_identifier_start search parameter. |
SP_medium_end | String | The SP_medium_end search parameter. |
SP_medium_start | String | The SP_medium_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_requester | String | The SP_requester search parameter. |
SP_replaces | String | The SP_replaces search parameter. |
Condition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
clinicalStatus_coding | String | The coding of the clinicalStatus. The clinical status of the condition. |
clinicalStatus_text | String | The text of the clinicalStatus. The clinical status of the condition. |
verificationStatus_coding | String | The coding of the verificationStatus. The verification status to support the clinical status of the condition. |
verificationStatus_text | String | The text of the verificationStatus. The verification status to support the clinical status of the condition. |
category_coding | String | The coding of the category. A category assigned to the condition. |
category_text | String | The text of the category. A category assigned to the condition. |
severity_coding | String | The coding of the severity. A subjective assessment of the severity of the condition as evaluated by the clinician. |
severity_text | String | The text of the severity. A subjective assessment of the severity of the condition as evaluated by the clinician. |
code_coding | String | The coding of the code. Identification of the condition, problem or diagnosis. |
code_text | String | The text of the code. Identification of the condition, problem or diagnosis. |
bodySite_coding | String | The coding of the bodySite. The anatomical location where this condition manifests itself. |
bodySite_text | String | The text of the bodySite. The anatomical location where this condition manifests itself. |
subject_display | String | The display of the subject. Indicates the patient or group who the condition record is associated with. |
subject_reference | String | The reference of the subject. Indicates the patient or group who the condition record is associated with. |
subject_identifier_value | String | The value of the subject-identifier. Indicates the patient or group who the condition record is associated with. |
subject_type | String | The subject-type of the subject-type. Indicates the patient or group who the condition record is associated with. |
encounter_display | String | The display of the encounter. The Encounter during which this Condition was created or to which the creation of this record is tightly associated. |
encounter_reference | String | The reference of the encounter. The Encounter during which this Condition was created or to which the creation of this record is tightly associated. |
encounter_identifier_value | String | The value of the encounter-identifier. The Encounter during which this Condition was created or to which the creation of this record is tightly associated. |
encounter_type | String | The encounter-type of the encounter-type. The Encounter during which this Condition was created or to which the creation of this record is tightly associated. |
onset_x_ | Datetime | Estimated or actual date or date-time the condition began, in the opinion of the clinician. |
abatement_x_ | Datetime | The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate. |
recordedDate | Datetime | The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date. |
recorder_display | String | The display of the recorder. Individual who recorded the record and takes responsibility for its content. |
recorder_reference | String | The reference of the recorder. Individual who recorded the record and takes responsibility for its content. |
recorder_identifier_value | String | The value of the recorder-identifier. Individual who recorded the record and takes responsibility for its content. |
recorder_type | String | The recorder-type of the recorder-type. Individual who recorded the record and takes responsibility for its content. |
asserter_display | String | The display of the asserter. Individual who is making the condition statement. |
asserter_reference | String | The reference of the asserter. Individual who is making the condition statement. |
asserter_identifier_value | String | The value of the asserter-identifier. Individual who is making the condition statement. |
asserter_type | String | The asserter-type of the asserter-type. Individual who is making the condition statement. |
stage_id | String | The stage-id of the stage-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
stage_extension | String | The stage-extension of the stage-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
stage_modifierExtension | String | The stage-modifierExtension of the stage-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
stage_summary_coding | String | The coding of the stage-summary. A simple summary of the stage such as 'Stage 3'. The determination of the stage is disease-specific. |
stage_summary_text | String | The text of the stage-summary. A simple summary of the stage such as 'Stage 3'. The determination of the stage is disease-specific. |
stage_assessment_display | String | The display of the stage-assessment. Reference to a formal record of the evidence on which the staging assessment is based. |
stage_assessment_reference | String | The reference of the stage-assessment. Reference to a formal record of the evidence on which the staging assessment is based. |
stage_assessment_identifier_value | String | The value of the stage-assessment-identifier. Reference to a formal record of the evidence on which the staging assessment is based. |
stage_assessment_type | String | The stage-assessment-type of the stage-assessment-type. Reference to a formal record of the evidence on which the staging assessment is based. |
stage_type_coding | String | The coding of the stage-type. The kind of staging, such as pathological or clinical staging. |
stage_type_text | String | The text of the stage-type. The kind of staging, such as pathological or clinical staging. |
evidence_id | String | The evidence-id of the evidence-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
evidence_extension | String | The evidence-extension of the evidence-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
evidence_modifierExtension | String | The evidence-modifierExtension of the evidence-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
evidence_code_coding | String | The coding of the evidence-code. A manifestation or symptom that led to the recording of this condition. |
evidence_code_text | String | The text of the evidence-code. A manifestation or symptom that led to the recording of this condition. |
evidence_detail_display | String | The display of the evidence-detail. Links to other relevant information, including pathology reports. |
evidence_detail_reference | String | The reference of the evidence-detail. Links to other relevant information, including pathology reports. |
evidence_detail_identifier_value | String | The value of the evidence-detail-identifier. Links to other relevant information, including pathology reports. |
evidence_detail_type | String | The evidence-detail-type of the evidence-detail-type. Links to other relevant information, including pathology reports. |
note | String | Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis. |
SP_onset_age | String | The SP_onset_age search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_stage_end | String | The SP_stage_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_verification_status_start | String | The SP_verification_status_start search parameter. |
SP_body_site_start | String | The SP_body_site_start search parameter. |
SP_body_site_end | String | The SP_body_site_end search parameter. |
SP_verification_status_end | String | The SP_verification_status_end search parameter. |
SP_evidence_end | String | The SP_evidence_end search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_abatement_date | String | The SP_abatement_date search parameter. |
SP_evidence_detail | String | The SP_evidence_detail search parameter. |
SP_list | String | The SP_list search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_recorded_date | String | The SP_recorded_date search parameter. |
SP_stage_start | String | The SP_stage_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_abatement_string | String | The SP_abatement_string search parameter. |
SP_text | String | The SP_text search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_onset_date | String | The SP_onset_date search parameter. |
SP_onset_info | String | The SP_onset_info search parameter. |
SP_clinical_status_end | String | The SP_clinical_status_end search parameter. |
SP_abatement_age | String | The SP_abatement_age search parameter. |
SP_source | String | The SP_source search parameter. |
SP_severity_start | String | The SP_severity_start search parameter. |
SP_content | String | The SP_content search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_asserter | String | The SP_asserter search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_severity_end | String | The SP_severity_end search parameter. |
SP_clinical_status_start | String | The SP_clinical_status_start search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_evidence_start | String | The SP_evidence_start search parameter. |
Contract view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Unique identifier for this Contract or a derivative that references a Source Contract. |
identifier_use | String | The identifier-use of the identifier-use. Unique identifier for this Contract or a derivative that references a Source Contract. |
identifier_type_coding | String | The coding of the identifier-type. Unique identifier for this Contract or a derivative that references a Source Contract. |
identifier_type_text | String | The text of the identifier-type. Unique identifier for this Contract or a derivative that references a Source Contract. |
identifier_system | String | The identifier-system of the identifier-system. Unique identifier for this Contract or a derivative that references a Source Contract. |
identifier_period_start | String | The start of the identifier-period. Unique identifier for this Contract or a derivative that references a Source Contract. |
identifier_period_end | String | The end of the identifier-period. Unique identifier for this Contract or a derivative that references a Source Contract. |
url | String | Canonical identifier for this contract, represented as a URI (globally unique). |
version | String | An edition identifier used for business purposes to label business significant variants. |
status | String | The status of the resource instance. |
legalState_coding | String | The coding of the legalState. Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement. |
legalState_text | String | The text of the legalState. Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement. |
instantiatesCanonical_display | String | The display of the instantiatesCanonical. The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. |
instantiatesCanonical_reference | String | The reference of the instantiatesCanonical. The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. |
instantiatesCanonical_identifier_value | String | The value of the instantiatesCanonical-identifier. The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. |
instantiatesCanonical_type | String | The instantiatesCanonical-type of the instantiatesCanonical-type. The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. |
instantiatesUri | String | The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract. |
contentDerivative_coding | String | The coding of the contentDerivative. The minimal content derived from the basal information source at a specific stage in its lifecycle. |
contentDerivative_text | String | The text of the contentDerivative. The minimal content derived from the basal information source at a specific stage in its lifecycle. |
issued | Datetime | When this Contract was issued. |
applies_start | Datetime | The start of the applies. Relevant time or time-period when this Contract is applicable. |
applies_end | Datetime | The end of the applies. Relevant time or time-period when this Contract is applicable. |
expirationType_coding | String | The coding of the expirationType. Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract. |
expirationType_text | String | The text of the expirationType. Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract. |
subject_display | String | The display of the subject. The target entity impacted by or of interest to parties to the agreement. |
subject_reference | String | The reference of the subject. The target entity impacted by or of interest to parties to the agreement. |
subject_identifier_value | String | The value of the subject-identifier. The target entity impacted by or of interest to parties to the agreement. |
subject_type | String | The subject-type of the subject-type. The target entity impacted by or of interest to parties to the agreement. |
authority_display | String | The display of the authority. A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies. |
authority_reference | String | The reference of the authority. A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies. |
authority_identifier_value | String | The value of the authority-identifier. A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies. |
authority_type | String | The authority-type of the authority-type. A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies. |
domain_display | String | The display of the domain. Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources. |
domain_reference | String | The reference of the domain. Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources. |
domain_identifier_value | String | The value of the domain-identifier. Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources. |
domain_type | String | The domain-type of the domain-type. Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources. |
site_display | String | The display of the site. Sites in which the contract is complied with, exercised, or in force. |
site_reference | String | The reference of the site. Sites in which the contract is complied with, exercised, or in force. |
site_identifier_value | String | The value of the site-identifier. Sites in which the contract is complied with, exercised, or in force. |
site_type | String | The site-type of the site-type. Sites in which the contract is complied with, exercised, or in force. |
name | String | A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
title | String | A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. |
subtitle | String | An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. |
alias | String | Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation. |
author_display | String | The display of the author. The individual or organization that authored the Contract definition, derivative, or instance in any legal state. |
author_reference | String | The reference of the author. The individual or organization that authored the Contract definition, derivative, or instance in any legal state. |
author_identifier_value | String | The value of the author-identifier. The individual or organization that authored the Contract definition, derivative, or instance in any legal state. |
author_type | String | The author-type of the author-type. The individual or organization that authored the Contract definition, derivative, or instance in any legal state. |
scope_coding | String | The coding of the scope. A selector of legal concerns for this Contract definition, derivative, or instance in any legal state. |
scope_text | String | The text of the scope. A selector of legal concerns for this Contract definition, derivative, or instance in any legal state. |
topic_x_coding | String | The coding of the topic[x]. Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. |
topic_x_text | String | The text of the topic[x]. Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. |
type_coding | String | The coding of the type. A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract. |
type_text | String | The text of the type. A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract. |
subType_coding | String | The coding of the subType. Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope. |
subType_text | String | The text of the subType. Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope. |
contentDefinition_id | String | The contentDefinition-id of the contentDefinition-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
contentDefinition_extension | String | The contentDefinition-extension of the contentDefinition-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
contentDefinition_modifierExtension | String | The contentDefinition-modifierExtension of the contentDefinition-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
contentDefinition_type_coding | String | The coding of the contentDefinition-type. Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance policy or benefits under a program, e.g., workers compensation. |
contentDefinition_type_text | String | The text of the contentDefinition-type. Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance policy or benefits under a program, e.g., workers compensation. |
contentDefinition_subType_coding | String | The coding of the contentDefinition-subType. Detailed Precusory content type. |
contentDefinition_subType_text | String | The text of the contentDefinition-subType. Detailed Precusory content type. |
contentDefinition_publisher_display | String | The display of the contentDefinition-publisher. The individual or organization that published the Contract precursor content. |
contentDefinition_publisher_reference | String | The reference of the contentDefinition-publisher. The individual or organization that published the Contract precursor content. |
contentDefinition_publisher_identifier_value | String | The value of the contentDefinition-publisher-identifier. The individual or organization that published the Contract precursor content. |
contentDefinition_publisher_type | String | The contentDefinition-publisher-type of the contentDefinition-publisher-type. The individual or organization that published the Contract precursor content. |
contentDefinition_publicationDate | Datetime | The contentDefinition-publicationDate of the contentDefinition-publicationDate. The date (and optionally time) when the contract was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the contract changes. |
contentDefinition_publicationStatus | String | The contentDefinition-publicationStatus of the contentDefinition-publicationStatus. amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated. |
contentDefinition_copyright | String | The contentDefinition-copyright of the contentDefinition-copyright. A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content. |
term_id | String | The term-id of the term-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
term_extension | String | The term-extension of the term-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
term_modifierExtension | String | The term-modifierExtension of the term-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
term_identifier_value | String | The value of the term-identifier. Unique identifier for this particular Contract Provision. |
term_identifier_use | String | The term-identifier-use of the term-identifier-use. Unique identifier for this particular Contract Provision. |
term_identifier_type_coding | String | The coding of the term-identifier-type. Unique identifier for this particular Contract Provision. |
term_identifier_type_text | String | The text of the term-identifier-type. Unique identifier for this particular Contract Provision. |
term_identifier_system | String | The term-identifier-system of the term-identifier-system. Unique identifier for this particular Contract Provision. |
term_identifier_period_start | Datetime | The start of the term-identifier-period. Unique identifier for this particular Contract Provision. |
term_identifier_period_end | Datetime | The end of the term-identifier-period. Unique identifier for this particular Contract Provision. |
term_issued | Datetime | The term-issued of the term-issued. When this Contract Provision was issued. |
term_applies_start | Datetime | The start of the term-applies. Relevant time or time-period when this Contract Provision is applicable. |
term_applies_end | Datetime | The end of the term-applies. Relevant time or time-period when this Contract Provision is applicable. |
term_topic_x_coding | String | The coding of the term-topic[x]. The entity that the term applies to. |
term_topic_x_text | String | The text of the term-topic[x]. The entity that the term applies to. |
term_type_coding | String | The coding of the term-type. A legal clause or condition contained within a contract that requires one or both parties to perform a particular requirement by some specified time or prevents one or both parties from performing a particular requirement by some specified time. |
term_type_text | String | The text of the term-type. A legal clause or condition contained within a contract that requires one or both parties to perform a particular requirement by some specified time or prevents one or both parties from performing a particular requirement by some specified time. |
term_subType_coding | String | The coding of the term-subType. A specialized legal clause or condition based on overarching contract type. |
term_subType_text | String | The text of the term-subType. A specialized legal clause or condition based on overarching contract type. |
term_text | String | The term-text of the term-text. Statement of a provision in a policy or a contract. |
term_securityLabel_id | String | The term-securityLabel-id of the term-securityLabel-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
term_securityLabel_extension | String | The term-securityLabel-extension of the term-securityLabel-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
term_securityLabel_modifierExtension | String | The term-securityLabel-modifierExtension of the term-securityLabel-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
term_securityLabel_number | String | The term-securityLabel-number of the term-securityLabel-number. Number used to link this term or term element to the applicable Security Label. |
term_securityLabel_classification_version | String | The version of the term-securityLabel-classification. Security label privacy tag that species the level of confidentiality protection required for this term and/or term elements. |
term_securityLabel_classification_code | String | The code of the term-securityLabel-classification. Security label privacy tag that species the level of confidentiality protection required for this term and/or term elements. |
term_securityLabel_classification_display | String | The display of the term-securityLabel-classification. Security label privacy tag that species the level of confidentiality protection required for this term and/or term elements. |
term_securityLabel_classification_userSelected | Bool | The userSelected of the term-securityLabel-classification. Security label privacy tag that species the level of confidentiality protection required for this term and/or term elements. |
term_securityLabel_classification_system | String | The term-securityLabel-classification-system of the term-securityLabel-classification-system. Security label privacy tag that species the level of confidentiality protection required for this term and/or term elements. |
term_securityLabel_category_version | String | The version of the term-securityLabel-category. Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements. |
term_securityLabel_category_code | String | The code of the term-securityLabel-category. Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements. |
term_securityLabel_category_display | String | The display of the term-securityLabel-category. Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements. |
term_securityLabel_category_userSelected | String | The userSelected of the term-securityLabel-category. Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements. |
term_securityLabel_category_system | String | The term-securityLabel-category-system of the term-securityLabel-category-system. Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements. |
term_securityLabel_control_version | String | The version of the term-securityLabel-control. Security label privacy tag that species the manner in which term and/or term elements are to be protected. |
term_securityLabel_control_code | String | The code of the term-securityLabel-control. Security label privacy tag that species the manner in which term and/or term elements are to be protected. |
term_securityLabel_control_display | String | The display of the term-securityLabel-control. Security label privacy tag that species the manner in which term and/or term elements are to be protected. |
term_securityLabel_control_userSelected | String | The userSelected of the term-securityLabel-control. Security label privacy tag that species the manner in which term and/or term elements are to be protected. |
term_securityLabel_control_system | String | The term-securityLabel-control-system of the term-securityLabel-control-system. Security label privacy tag that species the manner in which term and/or term elements are to be protected. |
term_offer_id | String | The term-offer-id of the term-offer-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
term_offer_extension | String | The term-offer-extension of the term-offer-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
term_offer_modifierExtension | String | The term-offer-modifierExtension of the term-offer-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
term_offer_identifier_value | String | The value of the term-offer-identifier. Unique identifier for this particular Contract Provision. |
term_offer_identifier_use | String | The term-offer-identifier-use of the term-offer-identifier-use. Unique identifier for this particular Contract Provision. |
term_offer_identifier_type_coding | String | The coding of the term-offer-identifier-type. Unique identifier for this particular Contract Provision. |
term_offer_identifier_type_text | String | The text of the term-offer-identifier-type. Unique identifier for this particular Contract Provision. |
term_offer_identifier_system | String | The term-offer-identifier-system of the term-offer-identifier-system. Unique identifier for this particular Contract Provision. |
term_offer_identifier_period_start | String | The start of the term-offer-identifier-period. Unique identifier for this particular Contract Provision. |
term_offer_identifier_period_end | String | The end of the term-offer-identifier-period. Unique identifier for this particular Contract Provision. |
term_offer_party_id | String | The term-offer-party-id of the term-offer-party-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
term_offer_party_extension | String | The term-offer-party-extension of the term-offer-party-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
term_offer_party_modifierExtension | String | The term-offer-party-modifierExtension of the term-offer-party-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
term_offer_party_reference_display | String | The display of the term-offer-party-reference. Participant in the offer. |
term_offer_party_reference_reference | String | The reference of the term-offer-party-reference. Participant in the offer. |
term_offer_party_reference_identifier_value | String | The value of the term-offer-party-reference-identifier. Participant in the offer. |
term_offer_party_reference_type | String | The term-offer-party-reference-type of the term-offer-party-reference-type. Participant in the offer. |
term_offer_party_role_coding | String | The coding of the term-offer-party-role. How the party participates in the offer. |
term_offer_party_role_text | String | The text of the term-offer-party-role. How the party participates in the offer. |
term_offer_topic_display | String | The display of the term-offer-topic. The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30). |
term_offer_topic_reference | String | The reference of the term-offer-topic. The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30). |
term_offer_topic_identifier_value | String | The value of the term-offer-topic-identifier. The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30). |
term_offer_topic_type | String | The term-offer-topic-type of the term-offer-topic-type. The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30). |
term_offer_type_coding | String | The coding of the term-offer-type. Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit. |
term_offer_type_text | String | The text of the term-offer-type. Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit. |
term_offer_decision_coding | String | The coding of the term-offer-decision. Type of choice made by accepting party with respect to an offer made by an offeror/ grantee. |
term_offer_decision_text | String | The text of the term-offer-decision. Type of choice made by accepting party with respect to an offer made by an offeror/ grantee. |
term_offer_decisionMode_coding | String | The coding of the term-offer-decisionMode. How the decision about a Contract was conveyed. |
term_offer_decisionMode_text | String | The text of the term-offer-decisionMode. How the decision about a Contract was conveyed. |
term_offer_answer_id | String | The term-offer-answer-id of the term-offer-answer-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
term_offer_answer_extension | String | The term-offer-answer-extension of the term-offer-answer-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
term_offer_answer_modifierExtension | String | The term-offer-answer-modifierExtension of the term-offer-answer-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
term_offer_answer_value_x_ | Bool | The term-offer-answer-value[x] of the term-offer-answer-value[x]. Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. |
term_offer_text | String | The term-offer-text of the term-offer-text. Human readable form of this Contract Offer. |
term_offer_linkId | String | The term-offer-linkId of the term-offer-linkId. The id of the clause or question text of the offer in the referenced questionnaire/response. |
term_offer_securityLabelNumber | String | The term-offer-securityLabelNumber of the term-offer-securityLabelNumber. Security labels that protects the offer. |
term_asset_id | String | The term-asset-id of the term-asset-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
term_asset_extension | String | The term-asset-extension of the term-asset-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
term_asset_modifierExtension | String | The term-asset-modifierExtension of the term-asset-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
term_asset_scope_coding | String | The coding of the term-asset-scope. Differentiates the kind of the asset . |
term_asset_scope_text | String | The text of the term-asset-scope. Differentiates the kind of the asset . |
term_asset_type_coding | String | The coding of the term-asset-type. Target entity type about which the term may be concerned. |
term_asset_type_text | String | The text of the term-asset-type. Target entity type about which the term may be concerned. |
term_asset_typeReference_display | String | The display of the term-asset-typeReference. Associated entities. |
term_asset_typeReference_reference | String | The reference of the term-asset-typeReference. Associated entities. |
term_asset_typeReference_identifier_value | String | The value of the term-asset-typeReference-identifier. Associated entities. |
term_asset_typeReference_type | String | The term-asset-typeReference-type of the term-asset-typeReference-type. Associated entities. |
term_asset_subtype_coding | String | The coding of the term-asset-subtype. May be a subtype or part of an offered asset. |
term_asset_subtype_text | String | The text of the term-asset-subtype. May be a subtype or part of an offered asset. |
term_asset_relationship_version | String | The version of the term-asset-relationship. Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that refer to it, and/or are owned by the offeree. |
term_asset_relationship_code | String | The code of the term-asset-relationship. Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that refer to it, and/or are owned by the offeree. |
term_asset_relationship_display | String | The display of the term-asset-relationship. Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that refer to it, and/or are owned by the offeree. |
term_asset_relationship_userSelected | Bool | The userSelected of the term-asset-relationship. Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that refer to it, and/or are owned by the offeree. |
term_asset_relationship_system | String | The term-asset-relationship-system of the term-asset-relationship-system. Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that refer to it, and/or are owned by the offeree. |
term_asset_context_id | String | The term-asset-context-id of the term-asset-context-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
term_asset_context_extension | String | The term-asset-context-extension of the term-asset-context-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
term_asset_context_modifierExtension | String | The term-asset-context-modifierExtension of the term-asset-context-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
term_asset_context_reference_display | String | The display of the term-asset-context-reference. Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction. |
term_asset_context_reference_reference | String | The reference of the term-asset-context-reference. Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction. |
term_asset_context_reference_identifier_value | String | The value of the term-asset-context-reference-identifier. Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction. |
term_asset_context_reference_type | String | The term-asset-context-reference-type of the term-asset-context-reference-type. Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction. |
term_asset_context_code_coding | String | The coding of the term-asset-context-code. Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location. |
term_asset_context_code_text | String | The text of the term-asset-context-code. Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location. |
term_asset_context_text | String | The term-asset-context-text of the term-asset-context-text. Context description. |
term_asset_condition | String | The term-asset-condition of the term-asset-condition. Description of the quality and completeness of the asset that imay be a factor in its valuation. |
term_asset_periodType_coding | String | The coding of the term-asset-periodType. Type of Asset availability for use or ownership. |
term_asset_periodType_text | String | The text of the term-asset-periodType. Type of Asset availability for use or ownership. |
term_asset_period_start | String | The start of the term-asset-period. Asset relevant contractual time period. |
term_asset_period_end | String | The end of the term-asset-period. Asset relevant contractual time period. |
term_asset_usePeriod_start | String | The start of the term-asset-usePeriod. Time period of asset use. |
term_asset_usePeriod_end | String | The end of the term-asset-usePeriod. Time period of asset use. |
term_asset_text | String | The term-asset-text of the term-asset-text. Clause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in the formation of the contract. |
term_asset_linkId | String | The term-asset-linkId of the term-asset-linkId. Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse. |
SP_source | String | The SP_source search parameter. |
SP_signer | String | The SP_signer search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_authority | String | The SP_authority search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_instantiates | String | The SP_instantiates search parameter. |
SP_domain | String | The SP_domain search parameter. |
Coverage view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique identifier assigned to this coverage. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this coverage. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this coverage. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this coverage. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this coverage. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this coverage. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this coverage. |
status | String | The status of the resource instance. |
type_coding | String | The coding of the type. The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization. |
type_text | String | The text of the type. The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization. |
policyHolder_display | String | The display of the policyHolder. The party who 'owns' the insurance policy. |
policyHolder_reference | String | The reference of the policyHolder. The party who 'owns' the insurance policy. |
policyHolder_identifier_value | String | The value of the policyHolder-identifier. The party who 'owns' the insurance policy. |
policyHolder_type | String | The policyHolder-type of the policyHolder-type. The party who 'owns' the insurance policy. |
subscriber_display | String | The display of the subscriber. The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. |
subscriber_reference | String | The reference of the subscriber. The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. |
subscriber_identifier_value | String | The value of the subscriber-identifier. The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. |
subscriber_type | String | The subscriber-type of the subscriber-type. The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. |
subscriberId | String | The insurer assigned ID for the Subscriber. |
beneficiary_display | String | The display of the beneficiary. The party who benefits from the insurance coverage; the patient when products and/or services are provided. |
beneficiary_reference | String | The reference of the beneficiary. The party who benefits from the insurance coverage; the patient when products and/or services are provided. |
beneficiary_identifier_value | String | The value of the beneficiary-identifier. The party who benefits from the insurance coverage; the patient when products and/or services are provided. |
beneficiary_type | String | The beneficiary-type of the beneficiary-type. The party who benefits from the insurance coverage; the patient when products and/or services are provided. |
dependent | String | A unique identifier for a dependent under the coverage. |
relationship_coding | String | The coding of the relationship. The relationship of beneficiary (patient) to the subscriber. |
relationship_text | String | The text of the relationship. The relationship of beneficiary (patient) to the subscriber. |
period_start | Datetime | The start of the period. Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force. |
period_end | Datetime | The end of the period. Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force. |
payor_display | String | The display of the payor. The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. |
payor_reference | String | The reference of the payor. The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. |
payor_identifier_value | String | The value of the payor-identifier. The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. |
payor_type | String | The payor-type of the payor-type. The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. |
class_id | String | The class-id of the class-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
class_extension | String | The class-extension of the class-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
class_modifierExtension | String | The class-modifierExtension of the class-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
class_type_coding | String | The coding of the class-type. The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan. |
class_type_text | String | The text of the class-type. The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan. |
class_value | String | The class-value of the class-value. The alphanumeric string value associated with the insurer issued label. |
class_name | String | The class-name of the class-name. A short description for the class. |
order | Int | The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care. |
network | String | The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply. |
costToBeneficiary_id | String | The costToBeneficiary-id of the costToBeneficiary-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
costToBeneficiary_extension | String | The costToBeneficiary-extension of the costToBeneficiary-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
costToBeneficiary_modifierExtension | String | The costToBeneficiary-modifierExtension of the costToBeneficiary-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
costToBeneficiary_type_coding | String | The coding of the costToBeneficiary-type. The category of patient centric costs associated with treatment. |
costToBeneficiary_type_text | String | The text of the costToBeneficiary-type. The category of patient centric costs associated with treatment. |
costToBeneficiary_value_x_value | Decimal | The value of the costToBeneficiary-value[x]. The amount due from the patient for the cost category. |
costToBeneficiary_value_x_unit | String | The unit of the costToBeneficiary-value[x]. The amount due from the patient for the cost category. |
costToBeneficiary_value_x_system | String | The system of the costToBeneficiary-value[x]. The amount due from the patient for the cost category. |
costToBeneficiary_value_x_comparator | String | The costToBeneficiary-value[x]-comparator of the costToBeneficiary-value[x]-comparator. The amount due from the patient for the cost category. |
costToBeneficiary_value_x_code | String | The costToBeneficiary-value[x]-code of the costToBeneficiary-value[x]-code. The amount due from the patient for the cost category. |
costToBeneficiary_exception_id | String | The costToBeneficiary-exception-id of the costToBeneficiary-exception-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
costToBeneficiary_exception_extension | String | The costToBeneficiary-exception-extension of the costToBeneficiary-exception-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
costToBeneficiary_exception_modifierExtension | String | The costToBeneficiary-exception-modifierExtension of the costToBeneficiary-exception-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
costToBeneficiary_exception_type_coding | String | The coding of the costToBeneficiary-exception-type. The code for the specific exception. |
costToBeneficiary_exception_type_text | String | The text of the costToBeneficiary-exception-type. The code for the specific exception. |
costToBeneficiary_exception_period_start | Datetime | The start of the costToBeneficiary-exception-period. The timeframe during when the exception is in force. |
costToBeneficiary_exception_period_end | Datetime | The end of the costToBeneficiary-exception-period. The timeframe during when the exception is in force. |
subrogation | Bool | When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs. |
contract_display | String | The display of the contract. The policy(s) which constitute this insurance coverage. |
contract_reference | String | The reference of the contract. The policy(s) which constitute this insurance coverage. |
contract_identifier_value | String | The value of the contract-identifier. The policy(s) which constitute this insurance coverage. |
contract_type | String | The contract-type of the contract-type. The policy(s) which constitute this insurance coverage. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_policy_holder | String | The SP_policy_holder search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_subscriber | String | The SP_subscriber search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_class_type_end | String | The SP_class_type_end search parameter. |
SP_payor | String | The SP_payor search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_class_type_start | String | The SP_class_type_start search parameter. |
SP_beneficiary | String | The SP_beneficiary search parameter. |
CoverageEligibilityRequest view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique identifier assigned to this coverage eligiblity request. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this coverage eligiblity request. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this coverage eligiblity request. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this coverage eligiblity request. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this coverage eligiblity request. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this coverage eligiblity request. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this coverage eligiblity request. |
status | String | The status of the resource instance. |
priority_coding | String | The coding of the priority. When the requestor expects the processor to complete processing. |
priority_text | String | The text of the priority. When the requestor expects the processor to complete processing. |
purpose | String | Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified. |
patient_display | String | The display of the patient. The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. |
patient_reference | String | The reference of the patient. The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. |
patient_identifier_value | String | The value of the patient-identifier. The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. |
patient_type | String | The patient-type of the patient-type. The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. |
serviced_x_ | Date | The date or dates when the enclosed suite of services were performed or completed. |
created | Datetime | The date when this resource was created. |
enterer_display | String | The display of the enterer. Person who created the request. |
enterer_reference | String | The reference of the enterer. Person who created the request. |
enterer_identifier_value | String | The value of the enterer-identifier. Person who created the request. |
enterer_type | String | The enterer-type of the enterer-type. Person who created the request. |
provider_display | String | The display of the provider. The provider which is responsible for the request. |
provider_reference | String | The reference of the provider. The provider which is responsible for the request. |
provider_identifier_value | String | The value of the provider-identifier. The provider which is responsible for the request. |
provider_type | String | The provider-type of the provider-type. The provider which is responsible for the request. |
insurer_display | String | The display of the insurer. The Insurer who issued the coverage in question and is the recipient of the request. |
insurer_reference | String | The reference of the insurer. The Insurer who issued the coverage in question and is the recipient of the request. |
insurer_identifier_value | String | The value of the insurer-identifier. The Insurer who issued the coverage in question and is the recipient of the request. |
insurer_type | String | The insurer-type of the insurer-type. The Insurer who issued the coverage in question and is the recipient of the request. |
facility_display | String | The display of the facility. Facility where the services are intended to be provided. |
facility_reference | String | The reference of the facility. Facility where the services are intended to be provided. |
facility_identifier_value | String | The value of the facility-identifier. Facility where the services are intended to be provided. |
facility_type | String | The facility-type of the facility-type. Facility where the services are intended to be provided. |
supportingInfo_id | String | The supportingInfo-id of the supportingInfo-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
supportingInfo_extension | String | The supportingInfo-extension of the supportingInfo-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
supportingInfo_modifierExtension | String | The supportingInfo-modifierExtension of the supportingInfo-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
supportingInfo_sequence | Int | The supportingInfo-sequence of the supportingInfo-sequence. A number to uniquely identify supporting information entries. |
supportingInfo_information_display | String | The display of the supportingInfo-information. Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
supportingInfo_information_reference | String | The reference of the supportingInfo-information. Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
supportingInfo_information_identifier_value | String | The value of the supportingInfo-information-identifier. Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
supportingInfo_information_type | String | The supportingInfo-information-type of the supportingInfo-information-type. Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
supportingInfo_appliesToAll | Bool | The supportingInfo-appliesToAll of the supportingInfo-appliesToAll. The supporting materials are applicable for all detail items, product/servce categories and specific billing codes. |
insurance_id | String | The insurance-id of the insurance-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
insurance_extension | String | The insurance-extension of the insurance-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
insurance_modifierExtension | String | The insurance-modifierExtension of the insurance-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
insurance_focal | Bool | The insurance-focal of the insurance-focal. A flag to indicate that this Coverage is to be used for evaluation of this request when set to true. |
insurance_coverage_display | String | The display of the insurance-coverage. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_coverage_reference | String | The reference of the insurance-coverage. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_coverage_identifier_value | String | The value of the insurance-coverage-identifier. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_coverage_type | String | The insurance-coverage-type of the insurance-coverage-type. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_businessArrangement | String | The insurance-businessArrangement of the insurance-businessArrangement. A business agreement number established between the provider and the insurer for special business processing purposes. |
item_id | String | The item-id of the item-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_extension | String | The item-extension of the item-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_modifierExtension | String | The item-modifierExtension of the item-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_supportingInfoSequence | String | The item-supportingInfoSequence of the item-supportingInfoSequence. Exceptions, special conditions and supporting information applicable for this service or product line. |
item_category_coding | String | The coding of the item-category. Code to identify the general type of benefits under which products and services are provided. |
item_category_text | String | The text of the item-category. Code to identify the general type of benefits under which products and services are provided. |
item_productOrService_coding | String | The coding of the item-productOrService. This contains the product, service, drug or other billing code for the item. |
item_productOrService_text | String | The text of the item-productOrService. This contains the product, service, drug or other billing code for the item. |
item_modifier_coding | String | The coding of the item-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
item_modifier_text | String | The text of the item-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
item_provider_display | String | The display of the item-provider. The practitioner who is responsible for the product or service to be rendered to the patient. |
item_provider_reference | String | The reference of the item-provider. The practitioner who is responsible for the product or service to be rendered to the patient. |
item_provider_identifier_value | String | The value of the item-provider-identifier. The practitioner who is responsible for the product or service to be rendered to the patient. |
item_provider_type | String | The item-provider-type of the item-provider-type. The practitioner who is responsible for the product or service to be rendered to the patient. |
item_quantity_value | Decimal | The value of the item-quantity. The number of repetitions of a service or product. |
item_quantity_unit | String | The unit of the item-quantity. The number of repetitions of a service or product. |
item_quantity_system | String | The system of the item-quantity. The number of repetitions of a service or product. |
item_quantity_comparator | String | The item-quantity-comparator of the item-quantity-comparator. The number of repetitions of a service or product. |
item_quantity_code | String | The item-quantity-code of the item-quantity-code. The number of repetitions of a service or product. |
item_unitPrice | String | The item-unitPrice of the item-unitPrice. The amount charged to the patient by the provider for a single unit. |
item_facility_display | String | The display of the item-facility. Facility where the services will be provided. |
item_facility_reference | String | The reference of the item-facility. Facility where the services will be provided. |
item_facility_identifier_value | String | The value of the item-facility-identifier. Facility where the services will be provided. |
item_facility_type | String | The item-facility-type of the item-facility-type. Facility where the services will be provided. |
item_diagnosis_id | String | The item-diagnosis-id of the item-diagnosis-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_diagnosis_extension | String | The item-diagnosis-extension of the item-diagnosis-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_diagnosis_modifierExtension | String | The item-diagnosis-modifierExtension of the item-diagnosis-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_diagnosis_diagnosis_x_coding | String | The coding of the item-diagnosis-diagnosis[x]. The nature of illness or problem in a coded form or as a reference to an external defined Condition. |
item_diagnosis_diagnosis_x_text | String | The text of the item-diagnosis-diagnosis[x]. The nature of illness or problem in a coded form or as a reference to an external defined Condition. |
item_detail_display | String | The display of the item-detail. The plan/proposal/order describing the proposed service in detail. |
item_detail_reference | String | The reference of the item-detail. The plan/proposal/order describing the proposed service in detail. |
item_detail_identifier_value | String | The value of the item-detail-identifier. The plan/proposal/order describing the proposed service in detail. |
item_detail_type | String | The item-detail-type of the item-detail-type. The plan/proposal/order describing the proposed service in detail. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_facility | String | The SP_facility search parameter. |
SP_provider | String | The SP_provider search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_enterer | String | The SP_enterer search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
CoverageEligibilityResponse view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique identifier assigned to this coverage eligiblity request. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this coverage eligiblity request. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this coverage eligiblity request. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this coverage eligiblity request. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this coverage eligiblity request. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this coverage eligiblity request. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this coverage eligiblity request. |
status | String | The status of the resource instance. |
purpose | String | Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified. |
patient_display | String | The display of the patient. The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. |
patient_reference | String | The reference of the patient. The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. |
patient_identifier_value | String | The value of the patient-identifier. The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. |
patient_type | String | The patient-type of the patient-type. The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. |
serviced_x_ | Date | The date or dates when the enclosed suite of services were performed or completed. |
created | Datetime | The date this resource was created. |
requestor_display | String | The display of the requestor. The provider which is responsible for the request. |
requestor_reference | String | The reference of the requestor. The provider which is responsible for the request. |
requestor_identifier_value | String | The value of the requestor-identifier. The provider which is responsible for the request. |
requestor_type | String | The requestor-type of the requestor-type. The provider which is responsible for the request. |
request_display | String | The display of the request. Reference to the original request resource. |
request_reference | String | The reference of the request. Reference to the original request resource. |
request_identifier_value | String | The value of the request-identifier. Reference to the original request resource. |
request_type | String | The request-type of the request-type. Reference to the original request resource. |
outcome | String | The outcome of the request processing. |
disposition | String | A human readable description of the status of the adjudication. |
insurer_display | String | The display of the insurer. The Insurer who issued the coverage in question and is the author of the response. |
insurer_reference | String | The reference of the insurer. The Insurer who issued the coverage in question and is the author of the response. |
insurer_identifier_value | String | The value of the insurer-identifier. The Insurer who issued the coverage in question and is the author of the response. |
insurer_type | String | The insurer-type of the insurer-type. The Insurer who issued the coverage in question and is the author of the response. |
insurance_id | String | The insurance-id of the insurance-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
insurance_extension | String | The insurance-extension of the insurance-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
insurance_modifierExtension | String | The insurance-modifierExtension of the insurance-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
insurance_coverage_display | String | The display of the insurance-coverage. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_coverage_reference | String | The reference of the insurance-coverage. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_coverage_identifier_value | String | The value of the insurance-coverage-identifier. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_coverage_type | String | The insurance-coverage-type of the insurance-coverage-type. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_inforce | Bool | The insurance-inforce of the insurance-inforce. Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates. |
insurance_benefitPeriod_start | Datetime | The start of the insurance-benefitPeriod. The term of the benefits documented in this response. |
insurance_benefitPeriod_end | Datetime | The end of the insurance-benefitPeriod. The term of the benefits documented in this response. |
insurance_item_id | String | The insurance-item-id of the insurance-item-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
insurance_item_extension | String | The insurance-item-extension of the insurance-item-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
insurance_item_modifierExtension | String | The insurance-item-modifierExtension of the insurance-item-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
insurance_item_category_coding | String | The coding of the insurance-item-category. Code to identify the general type of benefits under which products and services are provided. |
insurance_item_category_text | String | The text of the insurance-item-category. Code to identify the general type of benefits under which products and services are provided. |
insurance_item_productOrService_coding | String | The coding of the insurance-item-productOrService. This contains the product, service, drug or other billing code for the item. |
insurance_item_productOrService_text | String | The text of the insurance-item-productOrService. This contains the product, service, drug or other billing code for the item. |
insurance_item_modifier_coding | String | The coding of the insurance-item-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
insurance_item_modifier_text | String | The text of the insurance-item-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
insurance_item_provider_display | String | The display of the insurance-item-provider. The practitioner who is eligible for the provision of the product or service. |
insurance_item_provider_reference | String | The reference of the insurance-item-provider. The practitioner who is eligible for the provision of the product or service. |
insurance_item_provider_identifier_value | String | The value of the insurance-item-provider-identifier. The practitioner who is eligible for the provision of the product or service. |
insurance_item_provider_type | String | The insurance-item-provider-type of the insurance-item-provider-type. The practitioner who is eligible for the provision of the product or service. |
insurance_item_excluded | Bool | The insurance-item-excluded of the insurance-item-excluded. True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage. |
insurance_item_name | String | The insurance-item-name of the insurance-item-name. A short name or tag for the benefit. |
insurance_item_description | String | The insurance-item-description of the insurance-item-description. A richer description of the benefit or services covered. |
insurance_item_network_coding | String | The coding of the insurance-item-network. Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers. |
insurance_item_network_text | String | The text of the insurance-item-network. Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers. |
insurance_item_unit_coding | String | The coding of the insurance-item-unit. Indicates if the benefits apply to an individual or to the family. |
insurance_item_unit_text | String | The text of the insurance-item-unit. Indicates if the benefits apply to an individual or to the family. |
insurance_item_term_coding | String | The coding of the insurance-item-term. The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'. |
insurance_item_term_text | String | The text of the insurance-item-term. The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'. |
insurance_item_benefit_id | String | The insurance-item-benefit-id of the insurance-item-benefit-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
insurance_item_benefit_extension | String | The insurance-item-benefit-extension of the insurance-item-benefit-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
insurance_item_benefit_modifierExtension | String | The insurance-item-benefit-modifierExtension of the insurance-item-benefit-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
insurance_item_benefit_type_coding | String | The coding of the insurance-item-benefit-type. Classification of benefit being provided. |
insurance_item_benefit_type_text | String | The text of the insurance-item-benefit-type. Classification of benefit being provided. |
insurance_item_benefit_allowed_x_ | String | The insurance-item-benefit-allowed[x] of the insurance-item-benefit-allowed[x]. The quantity of the benefit which is permitted under the coverage. |
insurance_item_benefit_used_x_ | String | The insurance-item-benefit-used[x] of the insurance-item-benefit-used[x]. The quantity of the benefit which have been consumed to date. |
insurance_item_authorizationRequired | Bool | The insurance-item-authorizationRequired of the insurance-item-authorizationRequired. A boolean flag indicating whether a preauthorization is required prior to actual service delivery. |
insurance_item_authorizationSupporting_coding | String | The coding of the insurance-item-authorizationSupporting. Codes or comments regarding information or actions associated with the preauthorization. |
insurance_item_authorizationSupporting_text | String | The text of the insurance-item-authorizationSupporting. Codes or comments regarding information or actions associated with the preauthorization. |
insurance_item_authorizationUrl | String | The insurance-item-authorizationUrl of the insurance-item-authorizationUrl. A web location for obtaining requirements or descriptive information regarding the preauthorization. |
preAuthRef | String | A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred. |
form_coding | String | The coding of the form. A code for the form to be used for printing the content. |
form_text | String | The text of the form. A code for the form to be used for printing the content. |
error_id | String | The error-id of the error-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
error_extension | String | The error-extension of the error-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
error_modifierExtension | String | The error-modifierExtension of the error-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
error_code_coding | String | The coding of the error-code. An error code,from a specified code system, which details why the eligibility check could not be performed. |
error_code_text | String | The text of the error-code. An error code,from a specified code system, which details why the eligibility check could not be performed. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_request | String | The SP_request search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_requestor | String | The SP_requestor search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_insurer | String | The SP_insurer search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
DetectedIssue view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifier associated with the detected issue record. |
identifier_use | String | The identifier-use of the identifier-use. Business identifier associated with the detected issue record. |
identifier_type_coding | String | The coding of the identifier-type. Business identifier associated with the detected issue record. |
identifier_type_text | String | The text of the identifier-type. Business identifier associated with the detected issue record. |
identifier_system | String | The identifier-system of the identifier-system. Business identifier associated with the detected issue record. |
identifier_period_start | String | The start of the identifier-period. Business identifier associated with the detected issue record. |
identifier_period_end | String | The end of the identifier-period. Business identifier associated with the detected issue record. |
status | String | Indicates the status of the detected issue. |
code_coding | String | The coding of the code. Identifies the general type of issue identified. |
code_text | String | The text of the code. Identifies the general type of issue identified. |
severity | String | Indicates the degree of importance associated with the identified issue based on the potential impact on the patient. |
patient_display | String | The display of the patient. Indicates the patient whose record the detected issue is associated with. |
patient_reference | String | The reference of the patient. Indicates the patient whose record the detected issue is associated with. |
patient_identifier_value | String | The value of the patient-identifier. Indicates the patient whose record the detected issue is associated with. |
patient_type | String | The patient-type of the patient-type. Indicates the patient whose record the detected issue is associated with. |
identified_x_ | Datetime | The date or period when the detected issue was initially identified. |
author_display | String | The display of the author. Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review. |
author_reference | String | The reference of the author. Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review. |
author_identifier_value | String | The value of the author-identifier. Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review. |
author_type | String | The author-type of the author-type. Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review. |
implicated_display | String | The display of the implicated. Indicates the resource representing the current activity or proposed activity that is potentially problematic. |
implicated_reference | String | The reference of the implicated. Indicates the resource representing the current activity or proposed activity that is potentially problematic. |
implicated_identifier_value | String | The value of the implicated-identifier. Indicates the resource representing the current activity or proposed activity that is potentially problematic. |
implicated_type | String | The implicated-type of the implicated-type. Indicates the resource representing the current activity or proposed activity that is potentially problematic. |
evidence_id | String | The evidence-id of the evidence-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
evidence_extension | String | The evidence-extension of the evidence-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
evidence_modifierExtension | String | The evidence-modifierExtension of the evidence-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
evidence_code_coding | String | The coding of the evidence-code. A manifestation that led to the recording of this detected issue. |
evidence_code_text | String | The text of the evidence-code. A manifestation that led to the recording of this detected issue. |
evidence_detail_display | String | The display of the evidence-detail. Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport. |
evidence_detail_reference | String | The reference of the evidence-detail. Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport. |
evidence_detail_identifier_value | String | The value of the evidence-detail-identifier. Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport. |
evidence_detail_type | String | The evidence-detail-type of the evidence-detail-type. Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport. |
detail | String | A textual explanation of the detected issue. |
reference | String | The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified. |
mitigation_id | String | The mitigation-id of the mitigation-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
mitigation_extension | String | The mitigation-extension of the mitigation-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
mitigation_modifierExtension | String | The mitigation-modifierExtension of the mitigation-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
mitigation_action_coding | String | The coding of the mitigation-action. Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue. |
mitigation_action_text | String | The text of the mitigation-action. Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue. |
mitigation_date | Datetime | The mitigation-date of the mitigation-date. Indicates when the mitigating action was documented. |
mitigation_author_display | String | The display of the mitigation-author. Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring. |
mitigation_author_reference | String | The reference of the mitigation-author. Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring. |
mitigation_author_identifier_value | String | The value of the mitigation-author-identifier. Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring. |
mitigation_author_type | String | The mitigation-author-type of the mitigation-author-type. Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_author | String | The SP_author search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_identified | String | The SP_identified search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_implicated | String | The SP_implicated search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
Device view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Unique instance identifiers assigned to a device by manufacturers other organizations or owners. |
identifier_use | String | The identifier-use of the identifier-use. Unique instance identifiers assigned to a device by manufacturers other organizations or owners. |
identifier_type_coding | String | The coding of the identifier-type. Unique instance identifiers assigned to a device by manufacturers other organizations or owners. |
identifier_type_text | String | The text of the identifier-type. Unique instance identifiers assigned to a device by manufacturers other organizations or owners. |
identifier_system | String | The identifier-system of the identifier-system. Unique instance identifiers assigned to a device by manufacturers other organizations or owners. |
identifier_period_start | String | The start of the identifier-period. Unique instance identifiers assigned to a device by manufacturers other organizations or owners. |
identifier_period_end | String | The end of the identifier-period. Unique instance identifiers assigned to a device by manufacturers other organizations or owners. |
definition_display | String | The display of the definition. The reference to the definition for the device. |
definition_reference | String | The reference of the definition. The reference to the definition for the device. |
definition_identifier_value | String | The value of the definition-identifier. The reference to the definition for the device. |
definition_type | String | The definition-type of the definition-type. The reference to the definition for the device. |
udiCarrier_id | String | The udiCarrier-id of the udiCarrier-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
udiCarrier_extension | String | The udiCarrier-extension of the udiCarrier-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
udiCarrier_modifierExtension | String | The udiCarrier-modifierExtension of the udiCarrier-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
udiCarrier_deviceIdentifier | String | The udiCarrier-deviceIdentifier of the udiCarrier-deviceIdentifier. The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device. |
udiCarrier_issuer | String | The udiCarrier-issuer of the udiCarrier-issuer. Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di. |
udiCarrier_jurisdiction | String | The udiCarrier-jurisdiction of the udiCarrier-jurisdiction. The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi. |
udiCarrier_carrierAIDC | String | The udiCarrier-carrierAIDC of the udiCarrier-carrierAIDC. The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats *SHALL* be base64 encoded. |
udiCarrier_carrierHRF | String | The udiCarrier-carrierHRF of the udiCarrier-carrierHRF. The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device. |
udiCarrier_entryType | String | The udiCarrier-entryType of the udiCarrier-entryType. A coded entry to indicate how the data was entered. |
status | String | Status of the Device availability. |
statusReason_coding | String | The coding of the statusReason. Reason for the dtatus of the Device availability. |
statusReason_text | String | The text of the statusReason. Reason for the dtatus of the Device availability. |
distinctIdentifier | String | The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product. |
manufacturer | String | A name of the manufacturer. |
manufactureDate | Datetime | The date and time when the device was manufactured. |
expirationDate | Datetime | The date and time beyond which this device is no longer valid or should not be used (if applicable). |
lotNumber | String | Lot number assigned by the manufacturer. |
serialNumber | String | The serial number assigned by the organization when the device was manufactured. |
deviceName_id | String | The deviceName-id of the deviceName-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
deviceName_extension | String | The deviceName-extension of the deviceName-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
deviceName_modifierExtension | String | The deviceName-modifierExtension of the deviceName-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
deviceName_name | String | The deviceName-name of the deviceName-name. The name that identifies the device. |
deviceName_type | String | The deviceName-type of the deviceName-type. The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName. |
modelNumber | String | The manufacturer's model number for the device. |
partNumber | String | The part number or catalog number of the device. |
type_coding | String | The coding of the type. The kind or type of device. |
type_text | String | The text of the type. The kind or type of device. |
specialization_id | String | The specialization-id of the specialization-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
specialization_extension | String | The specialization-extension of the specialization-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
specialization_modifierExtension | String | The specialization-modifierExtension of the specialization-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
specialization_systemType_coding | String | The coding of the specialization-systemType. The standard that is used to operate and communicate. |
specialization_systemType_text | String | The text of the specialization-systemType. The standard that is used to operate and communicate. |
specialization_version | String | The specialization-version of the specialization-version. The version of the standard that is used to operate and communicate. |
version_id | String | The version-id of the version-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
version_extension | String | The version-extension of the version-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
version_modifierExtension | String | The version-modifierExtension of the version-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
version_type_coding | String | The coding of the version-type. The type of the device version, e.g. manufacturer, approved, internal. |
version_type_text | String | The text of the version-type. The type of the device version, e.g. manufacturer, approved, internal. |
version_component_value | String | The value of the version-component. A single component of the device version. |
version_component_use | String | The version-component-use of the version-component-use. A single component of the device version. |
version_component_type_coding | String | The coding of the version-component-type. A single component of the device version. |
version_component_type_text | String | The text of the version-component-type. A single component of the device version. |
version_component_system | String | The version-component-system of the version-component-system. A single component of the device version. |
version_component_period_start | Datetime | The start of the version-component-period. A single component of the device version. |
version_component_period_end | Datetime | The end of the version-component-period. A single component of the device version. |
version_value | String | The version-value of the version-value. The version text. |
property_id | String | The property-id of the property-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
property_extension | String | The property-extension of the property-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
property_modifierExtension | String | The property-modifierExtension of the property-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
property_type_coding | String | The coding of the property-type. Code that specifies the property DeviceDefinitionPropetyCode (Extensible). |
property_type_text | String | The text of the property-type. Code that specifies the property DeviceDefinitionPropetyCode (Extensible). |
property_valueQuantity_value | String | The value of the property-valueQuantity. Property value as a quantity. |
property_valueQuantity_unit | String | The unit of the property-valueQuantity. Property value as a quantity. |
property_valueQuantity_system | String | The system of the property-valueQuantity. Property value as a quantity. |
property_valueQuantity_comparator | String | The property-valueQuantity-comparator of the property-valueQuantity-comparator. Property value as a quantity. |
property_valueQuantity_code | String | The property-valueQuantity-code of the property-valueQuantity-code. Property value as a quantity. |
property_valueCode_coding | String | The coding of the property-valueCode. Property value as a code, e.g., NTP4 (synced to NTP). |
property_valueCode_text | String | The text of the property-valueCode. Property value as a code, e.g., NTP4 (synced to NTP). |
patient_display | String | The display of the patient. Patient information, If the device is affixed to a person. |
patient_reference | String | The reference of the patient. Patient information, If the device is affixed to a person. |
patient_identifier_value | String | The value of the patient-identifier. Patient information, If the device is affixed to a person. |
patient_type | String | The patient-type of the patient-type. Patient information, If the device is affixed to a person. |
owner_display | String | The display of the owner. An organization that is responsible for the provision and ongoing maintenance of the device. |
owner_reference | String | The reference of the owner. An organization that is responsible for the provision and ongoing maintenance of the device. |
owner_identifier_value | String | The value of the owner-identifier. An organization that is responsible for the provision and ongoing maintenance of the device. |
owner_type | String | The owner-type of the owner-type. An organization that is responsible for the provision and ongoing maintenance of the device. |
contact_value | String | The value of the contact. Contact details for an organization or a particular human that is responsible for the device. |
contact_system | String | The contact-system of the contact-system. Contact details for an organization or a particular human that is responsible for the device. |
contact_use | String | The contact-use of the contact-use. Contact details for an organization or a particular human that is responsible for the device. |
contact_rank | String | The contact-rank of the contact-rank. Contact details for an organization or a particular human that is responsible for the device. |
contact_period_start | String | The start of the contact-period. Contact details for an organization or a particular human that is responsible for the device. |
contact_period_end | String | The end of the contact-period. Contact details for an organization or a particular human that is responsible for the device. |
location_display | String | The display of the location. The place where the device can be found. |
location_reference | String | The reference of the location. The place where the device can be found. |
location_identifier_value | String | The value of the location-identifier. The place where the device can be found. |
location_type | String | The location-type of the location-type. The place where the device can be found. |
url | String | A network address on which the device may be contacted directly. |
note | String | Descriptive information, usage information or implantation information that is not captured in an existing element. |
safety_coding | String | The coding of the safety. Provides additional safety characteristics about a medical device. For example devices containing latex. |
safety_text | String | The text of the safety. Provides additional safety characteristics about a medical device. For example devices containing latex. |
parent_display | String | The display of the parent. The device that this device is attached to or is part of. |
parent_reference | String | The reference of the parent. The device that this device is attached to or is part of. |
parent_identifier_value | String | The value of the parent-identifier. The device that this device is attached to or is part of. |
parent_type | String | The parent-type of the parent-type. The device that this device is attached to or is part of. |
SP_location | String | The SP_location search parameter. |
SP_source | String | The SP_source search parameter. |
SP_din_end | String | The SP_din_end search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_model | String | The SP_model search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_udi_di | String | The SP_udi_di search parameter. |
SP_list | String | The SP_list search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_udi_carrier | String | The SP_udi_carrier search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_din_start | String | The SP_din_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_device_name | String | The SP_device_name search parameter. |
SP_organization | String | The SP_organization search parameter. |
DeviceDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. |
identifier_use | String | The identifier-use of the identifier-use. Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. |
identifier_type_coding | String | The coding of the identifier-type. Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. |
identifier_type_text | String | The text of the identifier-type. Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. |
identifier_system | String | The identifier-system of the identifier-system. Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. |
identifier_period_start | String | The start of the identifier-period. Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. |
identifier_period_end | String | The end of the identifier-period. Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. |
udiDeviceIdentifier_id | String | The udiDeviceIdentifier-id of the udiDeviceIdentifier-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
udiDeviceIdentifier_extension | String | The udiDeviceIdentifier-extension of the udiDeviceIdentifier-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
udiDeviceIdentifier_modifierExtension | String | The udiDeviceIdentifier-modifierExtension of the udiDeviceIdentifier-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
udiDeviceIdentifier_deviceIdentifier | String | The udiDeviceIdentifier-deviceIdentifier of the udiDeviceIdentifier-deviceIdentifier. The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier. |
udiDeviceIdentifier_issuer | String | The udiDeviceIdentifier-issuer of the udiDeviceIdentifier-issuer. The organization that assigns the identifier algorithm. |
udiDeviceIdentifier_jurisdiction | String | The udiDeviceIdentifier-jurisdiction of the udiDeviceIdentifier-jurisdiction. The jurisdiction to which the deviceIdentifier applies. |
manufacturer_x_ | String | A name of the manufacturer. |
deviceName_id | String | The deviceName-id of the deviceName-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
deviceName_extension | String | The deviceName-extension of the deviceName-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
deviceName_modifierExtension | String | The deviceName-modifierExtension of the deviceName-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
deviceName_name | String | The deviceName-name of the deviceName-name. The name of the device. |
deviceName_type | String | The deviceName-type of the deviceName-type. The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName. |
modelNumber | String | The model number for the device. |
type_coding | String | The coding of the type. What kind of device or device system this is. |
type_text | String | The text of the type. What kind of device or device system this is. |
specialization_id | String | The specialization-id of the specialization-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
specialization_extension | String | The specialization-extension of the specialization-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
specialization_modifierExtension | String | The specialization-modifierExtension of the specialization-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
specialization_systemType | String | The specialization-systemType of the specialization-systemType. The standard that is used to operate and communicate. |
specialization_version | String | The specialization-version of the specialization-version. The version of the standard that is used to operate and communicate. |
version | String | The available versions of the device, e.g., software versions. |
safety_coding | String | The coding of the safety. Safety characteristics of the device. |
safety_text | String | The text of the safety. Safety characteristics of the device. |
shelfLifeStorage | String | Shelf Life and storage information. |
physicalCharacteristics | String | Dimensions, color etc. |
languageCode_coding | String | The coding of the languageCode. Language code for the human-readable text strings produced by the device (all supported). |
languageCode_text | String | The text of the languageCode. Language code for the human-readable text strings produced by the device (all supported). |
capability_id | String | The capability-id of the capability-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
capability_extension | String | The capability-extension of the capability-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
capability_modifierExtension | String | The capability-modifierExtension of the capability-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
capability_type_coding | String | The coding of the capability-type. Type of capability. |
capability_type_text | String | The text of the capability-type. Type of capability. |
capability_description_coding | String | The coding of the capability-description. Description of capability. |
capability_description_text | String | The text of the capability-description. Description of capability. |
property_id | String | The property-id of the property-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
property_extension | String | The property-extension of the property-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
property_modifierExtension | String | The property-modifierExtension of the property-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
property_type_coding | String | The coding of the property-type. Code that specifies the property DeviceDefinitionPropetyCode (Extensible). |
property_type_text | String | The text of the property-type. Code that specifies the property DeviceDefinitionPropetyCode (Extensible). |
property_valueQuantity_value | String | The value of the property-valueQuantity. Property value as a quantity. |
property_valueQuantity_unit | String | The unit of the property-valueQuantity. Property value as a quantity. |
property_valueQuantity_system | String | The system of the property-valueQuantity. Property value as a quantity. |
property_valueQuantity_comparator | String | The property-valueQuantity-comparator of the property-valueQuantity-comparator. Property value as a quantity. |
property_valueQuantity_code | String | The property-valueQuantity-code of the property-valueQuantity-code. Property value as a quantity. |
property_valueCode_coding | String | The coding of the property-valueCode. Property value as a code, e.g., NTP4 (synced to NTP). |
property_valueCode_text | String | The text of the property-valueCode. Property value as a code, e.g., NTP4 (synced to NTP). |
owner_display | String | The display of the owner. An organization that is responsible for the provision and ongoing maintenance of the device. |
owner_reference | String | The reference of the owner. An organization that is responsible for the provision and ongoing maintenance of the device. |
owner_identifier_value | String | The value of the owner-identifier. An organization that is responsible for the provision and ongoing maintenance of the device. |
owner_type | String | The owner-type of the owner-type. An organization that is responsible for the provision and ongoing maintenance of the device. |
contact_value | String | The value of the contact. Contact details for an organization or a particular human that is responsible for the device. |
contact_system | String | The contact-system of the contact-system. Contact details for an organization or a particular human that is responsible for the device. |
contact_use | String | The contact-use of the contact-use. Contact details for an organization or a particular human that is responsible for the device. |
contact_rank | String | The contact-rank of the contact-rank. Contact details for an organization or a particular human that is responsible for the device. |
contact_period_start | String | The start of the contact-period. Contact details for an organization or a particular human that is responsible for the device. |
contact_period_end | String | The end of the contact-period. Contact details for an organization or a particular human that is responsible for the device. |
url | String | A network address on which the device may be contacted directly. |
onlineInformation | String | Access to on-line information about the device. |
note | String | Descriptive information, usage information or implantation information that is not captured in an existing element. |
quantity_value | Decimal | The value of the quantity. The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product). |
quantity_unit | String | The unit of the quantity. The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product). |
quantity_system | String | The system of the quantity. The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product). |
quantity_comparator | String | The quantity-comparator of the quantity-comparator. The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product). |
quantity_code | String | The quantity-code of the quantity-code. The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product). |
parentDevice_display | String | The display of the parentDevice. The parent device it can be part of. |
parentDevice_reference | String | The reference of the parentDevice. The parent device it can be part of. |
parentDevice_identifier_value | String | The value of the parentDevice-identifier. The parent device it can be part of. |
parentDevice_type | String | The parentDevice-type of the parentDevice-type. The parent device it can be part of. |
material_id | String | The material-id of the material-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
material_extension | String | The material-extension of the material-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
material_modifierExtension | String | The material-modifierExtension of the material-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
material_substance_coding | String | The coding of the material-substance. The substance. |
material_substance_text | String | The text of the material-substance. The substance. |
material_alternate | Bool | The material-alternate of the material-alternate. Indicates an alternative material of the device. |
material_allergenicIndicator | Bool | The material-allergenicIndicator of the material-allergenicIndicator. Whether the substance is a known or suspected allergen. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_parent | String | The SP_parent search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
DeviceMetric view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID. |
identifier_use | String | The identifier-use of the identifier-use. Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID. |
identifier_type_coding | String | The coding of the identifier-type. Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID. |
identifier_type_text | String | The text of the identifier-type. Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID. |
identifier_system | String | The identifier-system of the identifier-system. Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID. |
identifier_period_start | String | The start of the identifier-period. Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID. |
identifier_period_end | String | The end of the identifier-period. Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID. |
type_coding | String | The coding of the type. Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc. |
type_text | String | The text of the type. Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc. |
unit_coding | String | The coding of the unit. Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc. |
unit_text | String | The text of the unit. Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc. |
source_display | String | The display of the source. Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc. |
source_reference | String | The reference of the source. Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc. |
source_identifier_value | String | The value of the source-identifier. Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc. |
source_type | String | The source-type of the source-type. Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc. |
parent_display | String | The display of the parent. Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location. |
parent_reference | String | The reference of the parent. Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location. |
parent_identifier_value | String | The value of the parent-identifier. Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location. |
parent_type | String | The parent-type of the parent-type. Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location. |
operationalStatus | String | Indicates current operational state of the device. For example: On, Off, Standby, etc. |
color | String | Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta. |
category | String | Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation. |
measurementPeriod | String | Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured. |
calibration_id | String | The calibration-id of the calibration-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
calibration_extension | String | The calibration-extension of the calibration-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
calibration_modifierExtension | String | The calibration-modifierExtension of the calibration-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
calibration_type | String | The calibration-type of the calibration-type. Describes the type of the calibration method. |
calibration_state | String | The calibration-state of the calibration-state. Describes the state of the calibration. |
calibration_time | String | The calibration-time of the calibration-time. Describes the time last calibration has been performed. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_parent | String | The SP_parent search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
DeviceRequest view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifiers assigned to this order by the orderer or by the receiver. |
identifier_use | String | The identifier-use of the identifier-use. Identifiers assigned to this order by the orderer or by the receiver. |
identifier_type_coding | String | The coding of the identifier-type. Identifiers assigned to this order by the orderer or by the receiver. |
identifier_type_text | String | The text of the identifier-type. Identifiers assigned to this order by the orderer or by the receiver. |
identifier_system | String | The identifier-system of the identifier-system. Identifiers assigned to this order by the orderer or by the receiver. |
identifier_period_start | String | The start of the identifier-period. Identifiers assigned to this order by the orderer or by the receiver. |
identifier_period_end | String | The end of the identifier-period. Identifiers assigned to this order by the orderer or by the receiver. |
instantiatesCanonical | String | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest. |
instantiatesUri | String | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest. |
basedOn_display | String | The display of the basedOn. Plan/proposal/order fulfilled by this request. |
basedOn_reference | String | The reference of the basedOn. Plan/proposal/order fulfilled by this request. |
basedOn_identifier_value | String | The value of the basedOn-identifier. Plan/proposal/order fulfilled by this request. |
basedOn_type | String | The basedOn-type of the basedOn-type. Plan/proposal/order fulfilled by this request. |
priorRequest_display | String | The display of the priorRequest. The request takes the place of the referenced completed or terminated request(s). |
priorRequest_reference | String | The reference of the priorRequest. The request takes the place of the referenced completed or terminated request(s). |
priorRequest_identifier_value | String | The value of the priorRequest-identifier. The request takes the place of the referenced completed or terminated request(s). |
priorRequest_type | String | The priorRequest-type of the priorRequest-type. The request takes the place of the referenced completed or terminated request(s). |
groupIdentifier_value | String | The value of the groupIdentifier. Composite request this is part of. |
groupIdentifier_use | String | The groupIdentifier-use of the groupIdentifier-use. Composite request this is part of. |
groupIdentifier_type_coding | String | The coding of the groupIdentifier-type. Composite request this is part of. |
groupIdentifier_type_text | String | The text of the groupIdentifier-type. Composite request this is part of. |
groupIdentifier_system | String | The groupIdentifier-system of the groupIdentifier-system. Composite request this is part of. |
groupIdentifier_period_start | Datetime | The start of the groupIdentifier-period. Composite request this is part of. |
groupIdentifier_period_end | Datetime | The end of the groupIdentifier-period. Composite request this is part of. |
status | String | The status of the request. |
intent | String | Whether the request is a proposal, plan, an original order or a reflex order. |
priority | String | Indicates how quickly the {{title}} should be addressed with respect to other requests. |
code_x_display | String | The display of the code[x]. The details of the device to be used. |
code_x_reference | String | The reference of the code[x]. The details of the device to be used. |
code_x_identifier_value | String | The value of the code[x]-identifier. The details of the device to be used. |
code_x_type | String | The code[x]-type of the code[x]-type. The details of the device to be used. |
parameter_id | String | The parameter-id of the parameter-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
parameter_extension | String | The parameter-extension of the parameter-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
parameter_modifierExtension | String | The parameter-modifierExtension of the parameter-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
parameter_code_coding | String | The coding of the parameter-code. A code or string that identifies the device detail being asserted. |
parameter_code_text | String | The text of the parameter-code. A code or string that identifies the device detail being asserted. |
parameter_value_x_coding | String | The coding of the parameter-value[x]. The value of the device detail. |
parameter_value_x_text | String | The text of the parameter-value[x]. The value of the device detail. |
subject_display | String | The display of the subject. The patient who will use the device. |
subject_reference | String | The reference of the subject. The patient who will use the device. |
subject_identifier_value | String | The value of the subject-identifier. The patient who will use the device. |
subject_type | String | The subject-type of the subject-type. The patient who will use the device. |
encounter_display | String | The display of the encounter. An encounter that provides additional context in which this request is made. |
encounter_reference | String | The reference of the encounter. An encounter that provides additional context in which this request is made. |
encounter_identifier_value | String | The value of the encounter-identifier. An encounter that provides additional context in which this request is made. |
encounter_type | String | The encounter-type of the encounter-type. An encounter that provides additional context in which this request is made. |
occurrence_x_ | Datetime | The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. 'Every 8 hours'; 'Three times a day'; '1/2 an hour before breakfast for 10 days from 23-Dec 2011:'; '15 Oct 2013, 17 Oct 2013 and 1 Nov 2013'. |
authoredOn | Datetime | When the request transitioned to being actionable. |
requester_display | String | The display of the requester. The individual who initiated the request and has responsibility for its activation. |
requester_reference | String | The reference of the requester. The individual who initiated the request and has responsibility for its activation. |
requester_identifier_value | String | The value of the requester-identifier. The individual who initiated the request and has responsibility for its activation. |
requester_type | String | The requester-type of the requester-type. The individual who initiated the request and has responsibility for its activation. |
performerType_coding | String | The coding of the performerType. Desired type of performer for doing the diagnostic testing. |
performerType_text | String | The text of the performerType. Desired type of performer for doing the diagnostic testing. |
performer_display | String | The display of the performer. The desired performer for doing the diagnostic testing. |
performer_reference | String | The reference of the performer. The desired performer for doing the diagnostic testing. |
performer_identifier_value | String | The value of the performer-identifier. The desired performer for doing the diagnostic testing. |
performer_type | String | The performer-type of the performer-type. The desired performer for doing the diagnostic testing. |
reasonCode_coding | String | The coding of the reasonCode. Reason or justification for the use of this device. |
reasonCode_text | String | The text of the reasonCode. Reason or justification for the use of this device. |
reasonReference_display | String | The display of the reasonReference. Reason or justification for the use of this device. |
reasonReference_reference | String | The reference of the reasonReference. Reason or justification for the use of this device. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Reason or justification for the use of this device. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Reason or justification for the use of this device. |
insurance_display | String | The display of the insurance. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. |
insurance_reference | String | The reference of the insurance. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. |
insurance_identifier_value | String | The value of the insurance-identifier. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. |
insurance_type | String | The insurance-type of the insurance-type. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. |
supportingInfo_display | String | The display of the supportingInfo. Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site). |
supportingInfo_reference | String | The reference of the supportingInfo. Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site). |
supportingInfo_identifier_value | String | The value of the supportingInfo-identifier. Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site). |
supportingInfo_type | String | The supportingInfo-type of the supportingInfo-type. Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site). |
note | String | Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement. |
relevantHistory_display | String | The display of the relevantHistory. Key events in the history of the request. |
relevantHistory_reference | String | The reference of the relevantHistory. Key events in the history of the request. |
relevantHistory_identifier_value | String | The value of the relevantHistory-identifier. Key events in the history of the request. |
relevantHistory_type | String | The relevantHistory-type of the relevantHistory-type. Key events in the history of the request. |
SP_prior_request | String | The SP_prior_request search parameter. |
SP_source | String | The SP_source search parameter. |
SP_performer | String | The SP_performer search parameter. |
SP_instantiates_canonical | String | The SP_instantiates_canonical search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_event_date | String | The SP_event_date search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_instantiates_uri | String | The SP_instantiates_uri search parameter. |
SP_based_on | String | The SP_based_on search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_insurance | String | The SP_insurance search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_group_identifier_end | String | The SP_group_identifier_end search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_authored_on | String | The SP_authored_on search parameter. |
SP_device | String | The SP_device search parameter. |
SP_group_identifier_start | String | The SP_group_identifier_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_requester | String | The SP_requester search parameter. |
DeviceUseStatement view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. An external identifier for this statement such as an IRI. |
identifier_use | String | The identifier-use of the identifier-use. An external identifier for this statement such as an IRI. |
identifier_type_coding | String | The coding of the identifier-type. An external identifier for this statement such as an IRI. |
identifier_type_text | String | The text of the identifier-type. An external identifier for this statement such as an IRI. |
identifier_system | String | The identifier-system of the identifier-system. An external identifier for this statement such as an IRI. |
identifier_period_start | String | The start of the identifier-period. An external identifier for this statement such as an IRI. |
identifier_period_end | String | The end of the identifier-period. An external identifier for this statement such as an IRI. |
basedOn_display | String | The display of the basedOn. A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement. |
basedOn_reference | String | The reference of the basedOn. A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement. |
basedOn_identifier_value | String | The value of the basedOn-identifier. A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement. |
basedOn_type | String | The basedOn-type of the basedOn-type. A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement. |
status | String | A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed. |
subject_display | String | The display of the subject. The patient who used the device. |
subject_reference | String | The reference of the subject. The patient who used the device. |
subject_identifier_value | String | The value of the subject-identifier. The patient who used the device. |
subject_type | String | The subject-type of the subject-type. The patient who used the device. |
derivedFrom_display | String | The display of the derivedFrom. Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement. |
derivedFrom_reference | String | The reference of the derivedFrom. Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement. |
derivedFrom_identifier_value | String | The value of the derivedFrom-identifier. Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement. |
derivedFrom_type | String | The derivedFrom-type of the derivedFrom-type. Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement. |
timing_x_ | String | How often the device was used. |
recordedOn | Datetime | The time at which the statement was made/recorded. |
source_display | String | The display of the source. Who reported the device was being used by the patient. |
source_reference | String | The reference of the source. Who reported the device was being used by the patient. |
source_identifier_value | String | The value of the source-identifier. Who reported the device was being used by the patient. |
source_type | String | The source-type of the source-type. Who reported the device was being used by the patient. |
device_display | String | The display of the device. The details of the device used. |
device_reference | String | The reference of the device. The details of the device used. |
device_identifier_value | String | The value of the device-identifier. The details of the device used. |
device_type | String | The device-type of the device-type. The details of the device used. |
reasonCode_coding | String | The coding of the reasonCode. Reason or justification for the use of the device. |
reasonCode_text | String | The text of the reasonCode. Reason or justification for the use of the device. |
reasonReference_display | String | The display of the reasonReference. Indicates another resource whose existence justifies this DeviceUseStatement. |
reasonReference_reference | String | The reference of the reasonReference. Indicates another resource whose existence justifies this DeviceUseStatement. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Indicates another resource whose existence justifies this DeviceUseStatement. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Indicates another resource whose existence justifies this DeviceUseStatement. |
bodySite_coding | String | The coding of the bodySite. Indicates the anotomic location on the subject's body where the device was used ( i.e. the target). |
bodySite_text | String | The text of the bodySite. Indicates the anotomic location on the subject's body where the device was used ( i.e. the target). |
note | String | Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_device | String | The SP_device search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
DiagnosticReport view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifiers assigned to this report by the performer or other systems. |
identifier_use | String | The identifier-use of the identifier-use. Identifiers assigned to this report by the performer or other systems. |
identifier_type_coding | String | The coding of the identifier-type. Identifiers assigned to this report by the performer or other systems. |
identifier_type_text | String | The text of the identifier-type. Identifiers assigned to this report by the performer or other systems. |
identifier_system | String | The identifier-system of the identifier-system. Identifiers assigned to this report by the performer or other systems. |
identifier_period_start | String | The start of the identifier-period. Identifiers assigned to this report by the performer or other systems. |
identifier_period_end | String | The end of the identifier-period. Identifiers assigned to this report by the performer or other systems. |
basedOn_display | String | The display of the basedOn. Details concerning a service requested. |
basedOn_reference | String | The reference of the basedOn. Details concerning a service requested. |
basedOn_identifier_value | String | The value of the basedOn-identifier. Details concerning a service requested. |
basedOn_type | String | The basedOn-type of the basedOn-type. Details concerning a service requested. |
status | String | The status of the diagnostic report. |
category_coding | String | The coding of the category. A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. |
category_text | String | The text of the category. A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. |
code_coding | String | The coding of the code. A code or name that describes this diagnostic report. |
code_text | String | The text of the code. A code or name that describes this diagnostic report. |
subject_display | String | The display of the subject. The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources. |
subject_reference | String | The reference of the subject. The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources. |
subject_identifier_value | String | The value of the subject-identifier. The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources. |
subject_type | String | The subject-type of the subject-type. The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources. |
encounter_display | String | The display of the encounter. The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. |
encounter_reference | String | The reference of the encounter. The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. |
encounter_identifier_value | String | The value of the encounter-identifier. The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. |
encounter_type | String | The encounter-type of the encounter-type. The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. |
effective_x_ | Datetime | The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. |
issued | String | The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. |
performer_display | String | The display of the performer. The diagnostic service that is responsible for issuing the report. |
performer_reference | String | The reference of the performer. The diagnostic service that is responsible for issuing the report. |
performer_identifier_value | String | The value of the performer-identifier. The diagnostic service that is responsible for issuing the report. |
performer_type | String | The performer-type of the performer-type. The diagnostic service that is responsible for issuing the report. |
resultsInterpreter_display | String | The display of the resultsInterpreter. The practitioner or organization that is responsible for the report's conclusions and interpretations. |
resultsInterpreter_reference | String | The reference of the resultsInterpreter. The practitioner or organization that is responsible for the report's conclusions and interpretations. |
resultsInterpreter_identifier_value | String | The value of the resultsInterpreter-identifier. The practitioner or organization that is responsible for the report's conclusions and interpretations. |
resultsInterpreter_type | String | The resultsInterpreter-type of the resultsInterpreter-type. The practitioner or organization that is responsible for the report's conclusions and interpretations. |
specimen_display | String | The display of the specimen. Details about the specimens on which this diagnostic report is based. |
specimen_reference | String | The reference of the specimen. Details about the specimens on which this diagnostic report is based. |
specimen_identifier_value | String | The value of the specimen-identifier. Details about the specimens on which this diagnostic report is based. |
specimen_type | String | The specimen-type of the specimen-type. Details about the specimens on which this diagnostic report is based. |
result_display | String | The display of the result. [Observations](observation.html) that are part of this diagnostic report. |
result_reference | String | The reference of the result. [Observations](observation.html) that are part of this diagnostic report. |
result_identifier_value | String | The value of the result-identifier. [Observations](observation.html) that are part of this diagnostic report. |
result_type | String | The result-type of the result-type. [Observations](observation.html) that are part of this diagnostic report. |
imagingStudy_display | String | The display of the imagingStudy. One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. |
imagingStudy_reference | String | The reference of the imagingStudy. One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. |
imagingStudy_identifier_value | String | The value of the imagingStudy-identifier. One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. |
imagingStudy_type | String | The imagingStudy-type of the imagingStudy-type. One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. |
media_id | String | The media-id of the media-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
media_extension | String | The media-extension of the media-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
media_modifierExtension | String | The media-modifierExtension of the media-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
media_comment | String | The media-comment of the media-comment. A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features. |
media_link_display | String | The display of the media-link. Reference to the image source. |
media_link_reference | String | The reference of the media-link. Reference to the image source. |
media_link_identifier_value | String | The value of the media-link-identifier. Reference to the image source. |
media_link_type | String | The media-link-type of the media-link-type. Reference to the image source. |
conclusion | String | Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. |
conclusionCode_coding | String | The coding of the conclusionCode. One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. |
conclusionCode_text | String | The text of the conclusionCode. One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. |
presentedForm_data | String | The data of the presentedForm. Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
presentedForm_url | String | The url of the presentedForm. Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
presentedForm_size | String | The size of the presentedForm. Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
presentedForm_title | String | The title of the presentedForm. Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
presentedForm_creation | String | The creation of the presentedForm. Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
presentedForm_height | String | The height of the presentedForm. Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
presentedForm_width | String | The width of the presentedForm. Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
presentedForm_frames | String | The frames of the presentedForm. Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
presentedForm_duration | String | The duration of the presentedForm. Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
presentedForm_pages | String | The pages of the presentedForm. Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
presentedForm_contentType | String | The presentedForm-contentType of the presentedForm-contentType. Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
presentedForm_language | String | The presentedForm-language of the presentedForm-language. Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
SP_source | String | The SP_source search parameter. |
SP_specimen | String | The SP_specimen search parameter. |
SP_performer | String | The SP_performer search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_media | String | The SP_media search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_based_on | String | The SP_based_on search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_result | String | The SP_result search parameter. |
SP_list | String | The SP_list search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_assessed_condition | String | The SP_assessed_condition search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_date | String | The SP_date search parameter. |
SP_results_interpreter | String | The SP_results_interpreter search parameter. |
Endpoint view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifier for the organization that is used to identify the endpoint across multiple disparate systems. |
identifier_use | String | The identifier-use of the identifier-use. Identifier for the organization that is used to identify the endpoint across multiple disparate systems. |
identifier_type_coding | String | The coding of the identifier-type. Identifier for the organization that is used to identify the endpoint across multiple disparate systems. |
identifier_type_text | String | The text of the identifier-type. Identifier for the organization that is used to identify the endpoint across multiple disparate systems. |
identifier_system | String | The identifier-system of the identifier-system. Identifier for the organization that is used to identify the endpoint across multiple disparate systems. |
identifier_period_start | String | The start of the identifier-period. Identifier for the organization that is used to identify the endpoint across multiple disparate systems. |
identifier_period_end | String | The end of the identifier-period. Identifier for the organization that is used to identify the endpoint across multiple disparate systems. |
status | String | active | suspended | error | off | test. |
connectionType_version | String | The version of the connectionType. A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). |
connectionType_code | String | The code of the connectionType. A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). |
connectionType_display | String | The display of the connectionType. A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). |
connectionType_userSelected | Bool | The userSelected of the connectionType. A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). |
connectionType_system | String | The connectionType-system of the connectionType-system. A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). |
name | String | A friendly name that this endpoint can be referred to with. |
managingOrganization_display | String | The display of the managingOrganization. The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data). |
managingOrganization_reference | String | The reference of the managingOrganization. The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data). |
managingOrganization_identifier_value | String | The value of the managingOrganization-identifier. The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data). |
managingOrganization_type | String | The managingOrganization-type of the managingOrganization-type. The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data). |
contact_value | String | The value of the contact. Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. |
contact_system | String | The contact-system of the contact-system. Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. |
contact_use | String | The contact-use of the contact-use. Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. |
contact_rank | String | The contact-rank of the contact-rank. Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. |
contact_period_start | String | The start of the contact-period. Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. |
contact_period_end | String | The end of the contact-period. Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. |
period_start | Datetime | The start of the period. The interval during which the endpoint is expected to be operational. |
period_end | Datetime | The end of the period. The interval during which the endpoint is expected to be operational. |
payloadType_coding | String | The coding of the payloadType. The payload type describes the acceptable content that can be communicated on the endpoint. |
payloadType_text | String | The text of the payloadType. The payload type describes the acceptable content that can be communicated on the endpoint. |
payloadMimeType | String | The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType). |
address | String | The uri that describes the actual end-point to connect to. |
header | String | Additional headers / information to send as part of the notification. |
SP_source | String | The SP_source search parameter. |
SP_connection_type_start | String | The SP_connection_type_start search parameter. |
SP_connection_type_end | String | The SP_connection_type_end search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_payload_type_start | String | The SP_payload_type_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_payload_type_end | String | The SP_payload_type_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_organization | String | The SP_organization search parameter. |
EnrollmentRequest view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. The Response business identifier. |
identifier_use | String | The identifier-use of the identifier-use. The Response business identifier. |
identifier_type_coding | String | The coding of the identifier-type. The Response business identifier. |
identifier_type_text | String | The text of the identifier-type. The Response business identifier. |
identifier_system | String | The identifier-system of the identifier-system. The Response business identifier. |
identifier_period_start | String | The start of the identifier-period. The Response business identifier. |
identifier_period_end | String | The end of the identifier-period. The Response business identifier. |
status | String | The status of the resource instance. |
created | Datetime | The date when this resource was created. |
insurer_display | String | The display of the insurer. The Insurer who is target of the request. |
insurer_reference | String | The reference of the insurer. The Insurer who is target of the request. |
insurer_identifier_value | String | The value of the insurer-identifier. The Insurer who is target of the request. |
insurer_type | String | The insurer-type of the insurer-type. The Insurer who is target of the request. |
provider_display | String | The display of the provider. The practitioner who is responsible for the services rendered to the patient. |
provider_reference | String | The reference of the provider. The practitioner who is responsible for the services rendered to the patient. |
provider_identifier_value | String | The value of the provider-identifier. The practitioner who is responsible for the services rendered to the patient. |
provider_type | String | The provider-type of the provider-type. The practitioner who is responsible for the services rendered to the patient. |
candidate_display | String | The display of the candidate. Patient Resource. |
candidate_reference | String | The reference of the candidate. Patient Resource. |
candidate_identifier_value | String | The value of the candidate-identifier. Patient Resource. |
candidate_type | String | The candidate-type of the candidate-type. Patient Resource. |
coverage_display | String | The display of the coverage. Reference to the program or plan identification, underwriter or payor. |
coverage_reference | String | The reference of the coverage. Reference to the program or plan identification, underwriter or payor. |
coverage_identifier_value | String | The value of the coverage-identifier. Reference to the program or plan identification, underwriter or payor. |
coverage_type | String | The coverage-type of the coverage-type. Reference to the program or plan identification, underwriter or payor. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
EnrollmentResponse view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. The Response business identifier. |
identifier_use | String | The identifier-use of the identifier-use. The Response business identifier. |
identifier_type_coding | String | The coding of the identifier-type. The Response business identifier. |
identifier_type_text | String | The text of the identifier-type. The Response business identifier. |
identifier_system | String | The identifier-system of the identifier-system. The Response business identifier. |
identifier_period_start | String | The start of the identifier-period. The Response business identifier. |
identifier_period_end | String | The end of the identifier-period. The Response business identifier. |
status | String | The status of the resource instance. |
request_display | String | The display of the request. Original request resource reference. |
request_reference | String | The reference of the request. Original request resource reference. |
request_identifier_value | String | The value of the request-identifier. Original request resource reference. |
request_type | String | The request-type of the request-type. Original request resource reference. |
outcome | String | Processing status: error, complete. |
disposition | String | A description of the status of the adjudication. |
created | Datetime | The date when the enclosed suite of services were performed or completed. |
organization_display | String | The display of the organization. The Insurer who produced this adjudicated response. |
organization_reference | String | The reference of the organization. The Insurer who produced this adjudicated response. |
organization_identifier_value | String | The value of the organization-identifier. The Insurer who produced this adjudicated response. |
organization_type | String | The organization-type of the organization-type. The Insurer who produced this adjudicated response. |
requestProvider_display | String | The display of the requestProvider. The practitioner who is responsible for the services rendered to the patient. |
requestProvider_reference | String | The reference of the requestProvider. The practitioner who is responsible for the services rendered to the patient. |
requestProvider_identifier_value | String | The value of the requestProvider-identifier. The practitioner who is responsible for the services rendered to the patient. |
requestProvider_type | String | The requestProvider-type of the requestProvider-type. The practitioner who is responsible for the services rendered to the patient. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_request | String | The SP_request search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
EventDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URI that is used to identify this event definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this event definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the event definition is stored on different servers. |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_start | String | The start of the identifier-period. A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_end | String | The end of the identifier-period. A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
version | String | The identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
name | String | A natural language name identifying the event definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
title | String | A short, descriptive, user-friendly title for the event definition. |
subtitle | String | An explanatory or alternate title for the event definition giving additional information about its content. |
status | String | The status of this event definition. Enables tracking the life-cycle of the content. |
experimental | Bool | A Boolean value to indicate that this event definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
subject_x_coding | String | The coding of the subject[x]. A code or group definition that describes the intended subject of the event definition. |
subject_x_text | String | The text of the subject[x]. A code or group definition that describes the intended subject of the event definition. |
date | Datetime | The date (and optionally time) when the event definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the event definition changes. |
publisher | String | The name of the organization or individual that published the event definition. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
description | String | A free text natural language description of the event definition from a consumer's perspective. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances. |
jurisdiction_coding | String | The coding of the jurisdiction. A legal or geographic region in which the event definition is intended to be used. |
jurisdiction_text | String | The text of the jurisdiction. A legal or geographic region in which the event definition is intended to be used. |
purpose | String | Explanation of why this event definition is needed and why it has been designed as it has. |
usage | String | A detailed description of how the event definition is used from a clinical perspective. |
copyright | String | A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definition. |
approvalDate | Date | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
lastReviewDate | Date | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
effectivePeriod_start | Datetime | The start of the effectivePeriod. The period during which the event definition content was or is planned to be in active use. |
effectivePeriod_end | Datetime | The end of the effectivePeriod. The period during which the event definition content was or is planned to be in active use. |
topic_coding | String | The coding of the topic. Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching. |
topic_text | String | The text of the topic. Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching. |
author | String | An individiual or organization primarily involved in the creation and maintenance of the content. |
editor | String | An individual or organization primarily responsible for internal coherence of the content. |
reviewer | String | An individual or organization primarily responsible for review of some aspect of the content. |
endorser | String | An individual or organization responsible for officially endorsing the content for use in some setting. |
relatedArtifact | String | Related resources such as additional documentation, justification, or bibliographic references. |
trigger | String | The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met. |
SP_context_end | String | The SP_context_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_depends_on | String | The SP_depends_on search parameter. |
SP_predecessor | String | The SP_predecessor search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_jurisdiction_start | String | The SP_jurisdiction_start search parameter. |
SP_effective | String | The SP_effective search parameter. |
SP_topic_end | String | The SP_topic_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_context_type_start | String | The SP_context_type_start search parameter. |
SP_context_quantity | String | The SP_context_quantity search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_context_type_value | String | The SP_context_type_value search parameter. |
SP_successor | String | The SP_successor search parameter. |
SP_context_type_quantity | String | The SP_context_type_quantity search parameter. |
SP_derived_from | String | The SP_derived_from search parameter. |
SP_context_type_end | String | The SP_context_type_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_context_start | String | The SP_context_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_composed_of | String | The SP_composed_of search parameter. |
SP_jurisdiction_end | String | The SP_jurisdiction_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_topic_start | String | The SP_topic_start search parameter. |
Evidence view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URI that is used to identify this evidence when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers. |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_start | String | The start of the identifier-period. A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_end | String | The end of the identifier-period. A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance. |
version | String | The identifier that is used to identify this version of the summary when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the summary author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
title | String | A short, descriptive, user-friendly title for the summary. |
citeAs_x_display | String | The display of the citeAs[x]. Citation Resource or display of suggested citation for this evidence. |
citeAs_x_reference | String | The reference of the citeAs[x]. Citation Resource or display of suggested citation for this evidence. |
citeAs_x_identifier_value | String | The value of the citeAs[x]-identifier. Citation Resource or display of suggested citation for this evidence. |
citeAs_x_type | String | The citeAs[x]-type of the citeAs[x]-type. Citation Resource or display of suggested citation for this evidence. |
status | String | The status of this summary. Enables tracking the life-cycle of the content. |
date | Datetime | The date (and optionally time) when the summary was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the summary changes. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence instances. |
approvalDate | Date | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
lastReviewDate | Date | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
publisher | String | The name of the organization or individual that published the evidence. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
author | String | An individiual, organization, or device primarily involved in the creation and maintenance of the content. |
editor | String | An individiual, organization, or device primarily responsible for internal coherence of the content. |
reviewer | String | An individiual, organization, or device primarily responsible for review of some aspect of the content. |
endorser | String | An individiual, organization, or device responsible for officially endorsing the content for use in some setting. |
relatedArtifact | String | Link or citation to artifact associated with the summary. |
description | String | A free text natural language description of the evidence from a consumer's perspective. |
assertion | String | Declarative description of the Evidence. |
note | String | Footnotes and/or explanatory notes. |
variableDefinition_id | String | The variableDefinition-id of the variableDefinition-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
variableDefinition_extension | String | The variableDefinition-extension of the variableDefinition-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
variableDefinition_modifierExtension | String | The variableDefinition-modifierExtension of the variableDefinition-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
variableDefinition_description | String | The variableDefinition-description of the variableDefinition-description. A text description or summary of the variable. |
variableDefinition_note | String | The variableDefinition-note of the variableDefinition-note. Footnotes and/or explanatory notes. |
variableDefinition_variableRole_coding | String | The coding of the variableDefinition-variableRole. population | subpopulation | exposure | referenceExposure | measuredVariable | confounder. |
variableDefinition_variableRole_text | String | The text of the variableDefinition-variableRole. population | subpopulation | exposure | referenceExposure | measuredVariable | confounder. |
variableDefinition_observed_display | String | The display of the variableDefinition-observed. Definition of the actual variable related to the statistic(s). |
variableDefinition_observed_reference | String | The reference of the variableDefinition-observed. Definition of the actual variable related to the statistic(s). |
variableDefinition_observed_identifier_value | String | The value of the variableDefinition-observed-identifier. Definition of the actual variable related to the statistic(s). |
variableDefinition_observed_type | String | The variableDefinition-observed-type of the variableDefinition-observed-type. Definition of the actual variable related to the statistic(s). |
variableDefinition_intended_display | String | The display of the variableDefinition-intended. Definition of the intended variable related to the Evidence. |
variableDefinition_intended_reference | String | The reference of the variableDefinition-intended. Definition of the intended variable related to the Evidence. |
variableDefinition_intended_identifier_value | String | The value of the variableDefinition-intended-identifier. Definition of the intended variable related to the Evidence. |
variableDefinition_intended_type | String | The variableDefinition-intended-type of the variableDefinition-intended-type. Definition of the intended variable related to the Evidence. |
variableDefinition_directnessMatch_coding | String | The coding of the variableDefinition-directnessMatch. Indication of quality of match between intended variable to actual variable. |
variableDefinition_directnessMatch_text | String | The text of the variableDefinition-directnessMatch. Indication of quality of match between intended variable to actual variable. |
synthesisType_coding | String | The coding of the synthesisType. The method to combine studies. |
synthesisType_text | String | The text of the synthesisType. The method to combine studies. |
studyType_coding | String | The coding of the studyType. The type of study that produced this evidence. |
studyType_text | String | The text of the studyType. The type of study that produced this evidence. |
statistic_id | String | The statistic-id of the statistic-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
statistic_extension | String | The statistic-extension of the statistic-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
statistic_modifierExtension | String | The statistic-modifierExtension of the statistic-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
statistic_description | String | The statistic-description of the statistic-description. A description of the content value of the statistic. |
statistic_note | String | The statistic-note of the statistic-note. Footnotes and/or explanatory notes. |
statistic_statisticType_coding | String | The coding of the statistic-statisticType. Type of statistic, eg relative risk. |
statistic_statisticType_text | String | The text of the statistic-statisticType. Type of statistic, eg relative risk. |
statistic_category_coding | String | The coding of the statistic-category. When the measured variable is handled categorically, the category element is used to define which category the statistic is reporting. |
statistic_category_text | String | The text of the statistic-category. When the measured variable is handled categorically, the category element is used to define which category the statistic is reporting. |
statistic_quantity_value | Decimal | The value of the statistic-quantity. Statistic value. |
statistic_quantity_unit | String | The unit of the statistic-quantity. Statistic value. |
statistic_quantity_system | String | The system of the statistic-quantity. Statistic value. |
statistic_quantity_comparator | String | The statistic-quantity-comparator of the statistic-quantity-comparator. Statistic value. |
statistic_quantity_code | String | The statistic-quantity-code of the statistic-quantity-code. Statistic value. |
statistic_numberOfEvents | String | The statistic-numberOfEvents of the statistic-numberOfEvents. The number of events associated with the statistic, where the unit of analysis is different from numberAffected, sampleSize.knownDataCount and sampleSize.numberOfParticipants. |
statistic_numberAffected | String | The statistic-numberAffected of the statistic-numberAffected. The number of participants affected where the unit of analysis is the same as sampleSize.knownDataCount and sampleSize.numberOfParticipants. |
statistic_sampleSize_id | String | The statistic-sampleSize-id of the statistic-sampleSize-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
statistic_sampleSize_extension | String | The statistic-sampleSize-extension of the statistic-sampleSize-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
statistic_sampleSize_modifierExtension | String | The statistic-sampleSize-modifierExtension of the statistic-sampleSize-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
statistic_sampleSize_description | String | The statistic-sampleSize-description of the statistic-sampleSize-description. Human-readable summary of population sample size. |
statistic_sampleSize_note | String | The statistic-sampleSize-note of the statistic-sampleSize-note. Footnote or explanatory note about the sample size. |
statistic_sampleSize_numberOfStudies | String | The statistic-sampleSize-numberOfStudies of the statistic-sampleSize-numberOfStudies. Number of participants in the population. |
statistic_sampleSize_numberOfParticipants | String | The statistic-sampleSize-numberOfParticipants of the statistic-sampleSize-numberOfParticipants. A human-readable string to clarify or explain concepts about the sample size. |
statistic_sampleSize_knownDataCount | String | The statistic-sampleSize-knownDataCount of the statistic-sampleSize-knownDataCount. Number of participants with known results for measured variables. |
statistic_attributeEstimate_id | String | The statistic-attributeEstimate-id of the statistic-attributeEstimate-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
statistic_attributeEstimate_extension | String | The statistic-attributeEstimate-extension of the statistic-attributeEstimate-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
statistic_attributeEstimate_modifierExtension | String | The statistic-attributeEstimate-modifierExtension of the statistic-attributeEstimate-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
statistic_attributeEstimate_description | String | The statistic-attributeEstimate-description of the statistic-attributeEstimate-description. Human-readable summary of the estimate. |
statistic_attributeEstimate_note | String | The statistic-attributeEstimate-note of the statistic-attributeEstimate-note. Footnote or explanatory note about the estimate. |
statistic_attributeEstimate_type_coding | String | The coding of the statistic-attributeEstimate-type. The type of attribute estimate, eg confidence interval or p value. |
statistic_attributeEstimate_type_text | String | The text of the statistic-attributeEstimate-type. The type of attribute estimate, eg confidence interval or p value. |
statistic_attributeEstimate_quantity_value | Decimal | The value of the statistic-attributeEstimate-quantity. The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure. |
statistic_attributeEstimate_quantity_unit | String | The unit of the statistic-attributeEstimate-quantity. The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure. |
statistic_attributeEstimate_quantity_system | String | The system of the statistic-attributeEstimate-quantity. The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure. |
statistic_attributeEstimate_quantity_comparator | String | The statistic-attributeEstimate-quantity-comparator of the statistic-attributeEstimate-quantity-comparator. The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure. |
statistic_attributeEstimate_quantity_code | String | The statistic-attributeEstimate-quantity-code of the statistic-attributeEstimate-quantity-code. The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure. |
statistic_attributeEstimate_level | Decimal | The statistic-attributeEstimate-level of the statistic-attributeEstimate-level. Use 95 for a 95% confidence interval. |
statistic_attributeEstimate_range_low | String | The statistic-attributeEstimate-range-low of the statistic-attributeEstimate-range-low. Lower bound of confidence interval. |
statistic_attributeEstimate_range_high | String | The statistic-attributeEstimate-range-high of the statistic-attributeEstimate-range-high. Lower bound of confidence interval. |
SP_context_end | String | The SP_context_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_context_type_start | String | The SP_context_type_start search parameter. |
SP_context_quantity | String | The SP_context_quantity search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_context_type_value | String | The SP_context_type_value search parameter. |
SP_context_type_quantity | String | The SP_context_type_quantity search parameter. |
SP_context_type_end | String | The SP_context_type_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_context_start | String | The SP_context_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
EvidenceReport view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URI that is used to identify this EvidenceReport when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers. |
status | String | The status of this summary. Enables tracking the life-cycle of the content. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence report instances. |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_start | String | The start of the identifier-period. A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_end | String | The end of the identifier-period. A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instance. |
relatedIdentifier_value | String | The value of the relatedIdentifier. A formal identifier that is used to identify things closely related to this EvidenceReport. |
relatedIdentifier_use | String | The relatedIdentifier-use of the relatedIdentifier-use. A formal identifier that is used to identify things closely related to this EvidenceReport. |
relatedIdentifier_type_coding | String | The coding of the relatedIdentifier-type. A formal identifier that is used to identify things closely related to this EvidenceReport. |
relatedIdentifier_type_text | String | The text of the relatedIdentifier-type. A formal identifier that is used to identify things closely related to this EvidenceReport. |
relatedIdentifier_system | String | The relatedIdentifier-system of the relatedIdentifier-system. A formal identifier that is used to identify things closely related to this EvidenceReport. |
relatedIdentifier_period_start | String | The start of the relatedIdentifier-period. A formal identifier that is used to identify things closely related to this EvidenceReport. |
relatedIdentifier_period_end | String | The end of the relatedIdentifier-period. A formal identifier that is used to identify things closely related to this EvidenceReport. |
citeAs_x_display | String | The display of the citeAs[x]. Citation Resource or display of suggested citation for this report. |
citeAs_x_reference | String | The reference of the citeAs[x]. Citation Resource or display of suggested citation for this report. |
citeAs_x_identifier_value | String | The value of the citeAs[x]-identifier. Citation Resource or display of suggested citation for this report. |
citeAs_x_type | String | The citeAs[x]-type of the citeAs[x]-type. Citation Resource or display of suggested citation for this report. |
type_coding | String | The coding of the type. Specifies the kind of report, such as grouping of classifiers, search results, or human-compiled expression. |
type_text | String | The text of the type. Specifies the kind of report, such as grouping of classifiers, search results, or human-compiled expression. |
note | String | Used for footnotes and annotations. |
relatedArtifact | String | Link, description or reference to artifact associated with the report. |
subject_id | String | The subject-id of the subject-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
subject_extension | String | The subject-extension of the subject-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
subject_modifierExtension | String | The subject-modifierExtension of the subject-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
subject_characteristic_id | String | The subject-characteristic-id of the subject-characteristic-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
subject_characteristic_extension | String | The subject-characteristic-extension of the subject-characteristic-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
subject_characteristic_modifierExtension | String | The subject-characteristic-modifierExtension of the subject-characteristic-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
subject_characteristic_code_coding | String | The coding of the subject-characteristic-code. Characteristic code. |
subject_characteristic_code_text | String | The text of the subject-characteristic-code. Characteristic code. |
subject_characteristic_value_x_display | String | The display of the subject-characteristic-value[x]. Characteristic value. |
subject_characteristic_value_x_reference | String | The reference of the subject-characteristic-value[x]. Characteristic value. |
subject_characteristic_value_x_identifier_value | String | The value of the subject-characteristic-value[x]-identifier. Characteristic value. |
subject_characteristic_value_x_type | String | The subject-characteristic-value[x]-type of the subject-characteristic-value[x]-type. Characteristic value. |
subject_characteristic_exclude | Bool | The subject-characteristic-exclude of the subject-characteristic-exclude. Is used to express not the characteristic. |
subject_characteristic_period_start | Datetime | The start of the subject-characteristic-period. Timeframe for the characteristic. |
subject_characteristic_period_end | Datetime | The end of the subject-characteristic-period. Timeframe for the characteristic. |
subject_note | String | The subject-note of the subject-note. Used for general notes and annotations not coded elsewhere. |
publisher | String | The name of the organization or individual that published the evidence report. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
author | String | An individiual, organization, or device primarily involved in the creation and maintenance of the content. |
editor | String | An individiual, organization, or device primarily responsible for internal coherence of the content. |
reviewer | String | An individiual, organization, or device primarily responsible for review of some aspect of the content. |
endorser | String | An individiual, organization, or device responsible for officially endorsing the content for use in some setting. |
relatesTo_id | String | The relatesTo-id of the relatesTo-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
relatesTo_extension | String | The relatesTo-extension of the relatesTo-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
relatesTo_modifierExtension | String | The relatesTo-modifierExtension of the relatesTo-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
relatesTo_code | String | The relatesTo-code of the relatesTo-code. The type of relationship that this composition has with anther composition or document. |
relatesTo_target_x_value | String | The value of the relatesTo-target[x]. The target composition/document of this relationship. |
relatesTo_target_x_use | String | The relatesTo-target[x]-use of the relatesTo-target[x]-use. The target composition/document of this relationship. |
relatesTo_target_x_type_coding | String | The coding of the relatesTo-target[x]-type. The target composition/document of this relationship. |
relatesTo_target_x_type_text | String | The text of the relatesTo-target[x]-type. The target composition/document of this relationship. |
relatesTo_target_x_system | String | The relatesTo-target[x]-system of the relatesTo-target[x]-system. The target composition/document of this relationship. |
relatesTo_target_x_period_start | Datetime | The start of the relatesTo-target[x]-period. The target composition/document of this relationship. |
relatesTo_target_x_period_end | Datetime | The end of the relatesTo-target[x]-period. The target composition/document of this relationship. |
section_id | String | The section-id of the section-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
section_extension | String | The section-extension of the section-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
section_modifierExtension | String | The section-modifierExtension of the section-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
section_title | String | The section-title of the section-title. The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. |
section_focus_coding | String | The coding of the section-focus. A code identifying the kind of content contained within the section. This should be consistent with the section title. |
section_focus_text | String | The text of the section-focus. A code identifying the kind of content contained within the section. This should be consistent with the section title. |
section_focusReference_display | String | The display of the section-focusReference. A definitional Resource identifying the kind of content contained within the section. This should be consistent with the section title. |
section_focusReference_reference | String | The reference of the section-focusReference. A definitional Resource identifying the kind of content contained within the section. This should be consistent with the section title. |
section_focusReference_identifier_value | String | The value of the section-focusReference-identifier. A definitional Resource identifying the kind of content contained within the section. This should be consistent with the section title. |
section_focusReference_type | String | The section-focusReference-type of the section-focusReference-type. A definitional Resource identifying the kind of content contained within the section. This should be consistent with the section title. |
section_author_display | String | The display of the section-author. Identifies who is responsible for the information in this section, not necessarily who typed it in. |
section_author_reference | String | The reference of the section-author. Identifies who is responsible for the information in this section, not necessarily who typed it in. |
section_author_identifier_value | String | The value of the section-author-identifier. Identifies who is responsible for the information in this section, not necessarily who typed it in. |
section_author_type | String | The section-author-type of the section-author-type. Identifies who is responsible for the information in this section, not necessarily who typed it in. |
section_text_div | String | The div of the section-text. A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is peferred to contain sufficient detail to make it acceptable for a human to just read the narrative. |
section_text_status | String | The status of the section-text. A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is peferred to contain sufficient detail to make it acceptable for a human to just read the narrative. |
section_mode | String | The section-mode of the section-mode. How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
section_orderedBy_coding | String | The coding of the section-orderedBy. Specifies the order applied to the items in the section entries. |
section_orderedBy_text | String | The text of the section-orderedBy. Specifies the order applied to the items in the section entries. |
section_entryClassifier_coding | String | The coding of the section-entryClassifier. Specifies any type of classification of the evidence report. |
section_entryClassifier_text | String | The text of the section-entryClassifier. Specifies any type of classification of the evidence report. |
section_entryReference_display | String | The display of the section-entryReference. A reference to the actual resource from which the narrative in the section is derived. |
section_entryReference_reference | String | The reference of the section-entryReference. A reference to the actual resource from which the narrative in the section is derived. |
section_entryReference_identifier_value | String | The value of the section-entryReference-identifier. A reference to the actual resource from which the narrative in the section is derived. |
section_entryReference_type | String | The section-entryReference-type of the section-entryReference-type. A reference to the actual resource from which the narrative in the section is derived. |
section_entryQuantity_value | String | The value of the section-entryQuantity. Quantity as content. |
section_entryQuantity_unit | String | The unit of the section-entryQuantity. Quantity as content. |
section_entryQuantity_system | String | The system of the section-entryQuantity. Quantity as content. |
section_entryQuantity_comparator | String | The section-entryQuantity-comparator of the section-entryQuantity-comparator. Quantity as content. |
section_entryQuantity_code | String | The section-entryQuantity-code of the section-entryQuantity-code. Quantity as content. |
section_emptyReason_coding | String | The coding of the section-emptyReason. If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
section_emptyReason_text | String | The text of the section-emptyReason. If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
SP_context_end | String | The SP_context_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_context_type_start | String | The SP_context_type_start search parameter. |
SP_context_quantity | String | The SP_context_quantity search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_context_type_value | String | The SP_context_type_value search parameter. |
SP_context_type_quantity | String | The SP_context_type_quantity search parameter. |
SP_context_type_end | String | The SP_context_type_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_context_start | String | The SP_context_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
EvidenceVariable view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URI that is used to identify this evidence variable when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable is stored on different servers. |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_start | String | The start of the identifier-period. A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_end | String | The end of the identifier-period. A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance. |
version | String | The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. |
name | String | A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
title | String | A short, descriptive, user-friendly title for the evidence variable. |
shortTitle | String | The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary. |
subtitle | String | An explanatory or alternate title for the EvidenceVariable giving additional information about its content. |
status | String | The status of this evidence variable. Enables tracking the life-cycle of the content. |
date | Datetime | The date (and optionally time) when the evidence variable was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changes. |
description | String | A free text natural language description of the evidence variable from a consumer's perspective. |
note | String | A human-readable string to clarify or explain concepts about the resource. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence variable instances. |
publisher | String | The name of the organization or individual that published the evidence variable. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
author | String | An individiual or organization primarily involved in the creation and maintenance of the content. |
editor | String | An individual or organization primarily responsible for internal coherence of the content. |
reviewer | String | An individual or organization primarily responsible for review of some aspect of the content. |
endorser | String | An individual or organization responsible for officially endorsing the content for use in some setting. |
relatedArtifact | String | Related artifacts such as additional documentation, justification, or bibliographic references. |
actual | Bool | True if the actual variable measured, false if a conceptual representation of the intended variable. |
characteristicCombination | String | Used to specify if two or more characteristics are combined with OR or AND. |
characteristic_id | String | The characteristic-id of the characteristic-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
characteristic_extension | String | The characteristic-extension of the characteristic-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
characteristic_modifierExtension | String | The characteristic-modifierExtension of the characteristic-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
characteristic_description | String | The characteristic-description of the characteristic-description. A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user. |
characteristic_definition_x_display | String | The display of the characteristic-definition[x]. Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). |
characteristic_definition_x_reference | String | The reference of the characteristic-definition[x]. Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). |
characteristic_definition_x_identifier_value | String | The value of the characteristic-definition[x]-identifier. Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). |
characteristic_definition_x_type | String | The characteristic-definition[x]-type of the characteristic-definition[x]-type. Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). |
characteristic_method_coding | String | The coding of the characteristic-method. Method used for describing characteristic. |
characteristic_method_text | String | The text of the characteristic-method. Method used for describing characteristic. |
characteristic_device_display | String | The display of the characteristic-device. Device used for determining characteristic. |
characteristic_device_reference | String | The reference of the characteristic-device. Device used for determining characteristic. |
characteristic_device_identifier_value | String | The value of the characteristic-device-identifier. Device used for determining characteristic. |
characteristic_device_type | String | The characteristic-device-type of the characteristic-device-type. Device used for determining characteristic. |
characteristic_exclude | Bool | The characteristic-exclude of the characteristic-exclude. When true, members with this characteristic are excluded from the element. |
characteristic_timeFromStart_id | String | The characteristic-timeFromStart-id of the characteristic-timeFromStart-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
characteristic_timeFromStart_extension | String | The characteristic-timeFromStart-extension of the characteristic-timeFromStart-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
characteristic_timeFromStart_modifierExtension | String | The characteristic-timeFromStart-modifierExtension of the characteristic-timeFromStart-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
characteristic_timeFromStart_description | String | The characteristic-timeFromStart-description of the characteristic-timeFromStart-description. A short, natural language description. |
characteristic_timeFromStart_quantity_value | Decimal | The value of the characteristic-timeFromStart-quantity. Used to express the observation at a defined amount of time after the study start. |
characteristic_timeFromStart_quantity_unit | String | The unit of the characteristic-timeFromStart-quantity. Used to express the observation at a defined amount of time after the study start. |
characteristic_timeFromStart_quantity_system | String | The system of the characteristic-timeFromStart-quantity. Used to express the observation at a defined amount of time after the study start. |
characteristic_timeFromStart_quantity_comparator | String | The characteristic-timeFromStart-quantity-comparator of the characteristic-timeFromStart-quantity-comparator. Used to express the observation at a defined amount of time after the study start. |
characteristic_timeFromStart_quantity_code | String | The characteristic-timeFromStart-quantity-code of the characteristic-timeFromStart-quantity-code. Used to express the observation at a defined amount of time after the study start. |
characteristic_timeFromStart_range_low | String | The characteristic-timeFromStart-range-low of the characteristic-timeFromStart-range-low. Used to express the observation within a period after the study start. |
characteristic_timeFromStart_range_high | String | The characteristic-timeFromStart-range-high of the characteristic-timeFromStart-range-high. Used to express the observation within a period after the study start. |
characteristic_timeFromStart_note | String | The characteristic-timeFromStart-note of the characteristic-timeFromStart-note. A human-readable string to clarify or explain concepts about the resource. |
characteristic_groupMeasure | String | The characteristic-groupMeasure of the characteristic-groupMeasure. Indicates how elements are aggregated within the study effective period. |
handling | String | Used for an outcome to classify. |
category_id | String | The category-id of the category-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
category_extension | String | The category-extension of the category-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
category_modifierExtension | String | The category-modifierExtension of the category-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
category_name | String | The category-name of the category-name. A human-readable title or representation of the grouping. |
category_value_x_coding | String | The coding of the category-value[x]. Value or set of values that define the grouping. |
category_value_x_text | String | The text of the category-value[x]. Value or set of values that define the grouping. |
SP_context_end | String | The SP_context_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_context_type_start | String | The SP_context_type_start search parameter. |
SP_context_quantity | String | The SP_context_quantity search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_context_type_value | String | The SP_context_type_value search parameter. |
SP_context_type_quantity | String | The SP_context_type_quantity search parameter. |
SP_context_type_end | String | The SP_context_type_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_context_start | String | The SP_context_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
ExplanationOfBenefit view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique identifier assigned to this explanation of benefit. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this explanation of benefit. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this explanation of benefit. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this explanation of benefit. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this explanation of benefit. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this explanation of benefit. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this explanation of benefit. |
status | String | The status of the resource instance. |
type_coding | String | The coding of the type. The category of claim, e.g. oral, pharmacy, vision, institutional, professional. |
type_text | String | The text of the type. The category of claim, e.g. oral, pharmacy, vision, institutional, professional. |
subType_coding | String | The coding of the subType. A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. |
subType_text | String | The text of the subType. A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. |
use | String | A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future. |
patient_display | String | The display of the patient. The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought. |
patient_reference | String | The reference of the patient. The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought. |
patient_identifier_value | String | The value of the patient-identifier. The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought. |
patient_type | String | The patient-type of the patient-type. The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought. |
billablePeriod_start | Datetime | The start of the billablePeriod. The period for which charges are being submitted. |
billablePeriod_end | Datetime | The end of the billablePeriod. The period for which charges are being submitted. |
created | Datetime | The date this resource was created. |
enterer_display | String | The display of the enterer. Individual who created the claim, predetermination or preauthorization. |
enterer_reference | String | The reference of the enterer. Individual who created the claim, predetermination or preauthorization. |
enterer_identifier_value | String | The value of the enterer-identifier. Individual who created the claim, predetermination or preauthorization. |
enterer_type | String | The enterer-type of the enterer-type. Individual who created the claim, predetermination or preauthorization. |
insurer_display | String | The display of the insurer. The party responsible for authorization, adjudication and reimbursement. |
insurer_reference | String | The reference of the insurer. The party responsible for authorization, adjudication and reimbursement. |
insurer_identifier_value | String | The value of the insurer-identifier. The party responsible for authorization, adjudication and reimbursement. |
insurer_type | String | The insurer-type of the insurer-type. The party responsible for authorization, adjudication and reimbursement. |
provider_display | String | The display of the provider. The provider which is responsible for the claim, predetermination or preauthorization. |
provider_reference | String | The reference of the provider. The provider which is responsible for the claim, predetermination or preauthorization. |
provider_identifier_value | String | The value of the provider-identifier. The provider which is responsible for the claim, predetermination or preauthorization. |
provider_type | String | The provider-type of the provider-type. The provider which is responsible for the claim, predetermination or preauthorization. |
priority_coding | String | The coding of the priority. The provider-required urgency of processing the request. Typical values include: stat, routine deferred. |
priority_text | String | The text of the priority. The provider-required urgency of processing the request. Typical values include: stat, routine deferred. |
fundsReserveRequested_coding | String | The coding of the fundsReserveRequested. A code to indicate whether and for whom funds are to be reserved for future claims. |
fundsReserveRequested_text | String | The text of the fundsReserveRequested. A code to indicate whether and for whom funds are to be reserved for future claims. |
fundsReserve_coding | String | The coding of the fundsReserve. A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom. |
fundsReserve_text | String | The text of the fundsReserve. A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom. |
related_id | String | The related-id of the related-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
related_extension | String | The related-extension of the related-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
related_modifierExtension | String | The related-modifierExtension of the related-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
related_claim_display | String | The display of the related-claim. Reference to a related claim. |
related_claim_reference | String | The reference of the related-claim. Reference to a related claim. |
related_claim_identifier_value | String | The value of the related-claim-identifier. Reference to a related claim. |
related_claim_type | String | The related-claim-type of the related-claim-type. Reference to a related claim. |
related_relationship_coding | String | The coding of the related-relationship. A code to convey how the claims are related. |
related_relationship_text | String | The text of the related-relationship. A code to convey how the claims are related. |
related_reference_value | String | The value of the related-reference. An alternate organizational reference to the case or file to which this particular claim pertains. |
related_reference_use | String | The related-reference-use of the related-reference-use. An alternate organizational reference to the case or file to which this particular claim pertains. |
related_reference_type_coding | String | The coding of the related-reference-type. An alternate organizational reference to the case or file to which this particular claim pertains. |
related_reference_type_text | String | The text of the related-reference-type. An alternate organizational reference to the case or file to which this particular claim pertains. |
related_reference_system | String | The related-reference-system of the related-reference-system. An alternate organizational reference to the case or file to which this particular claim pertains. |
related_reference_period_start | Datetime | The start of the related-reference-period. An alternate organizational reference to the case or file to which this particular claim pertains. |
related_reference_period_end | Datetime | The end of the related-reference-period. An alternate organizational reference to the case or file to which this particular claim pertains. |
prescription_display | String | The display of the prescription. Prescription to support the dispensing of pharmacy, device or vision products. |
prescription_reference | String | The reference of the prescription. Prescription to support the dispensing of pharmacy, device or vision products. |
prescription_identifier_value | String | The value of the prescription-identifier. Prescription to support the dispensing of pharmacy, device or vision products. |
prescription_type | String | The prescription-type of the prescription-type. Prescription to support the dispensing of pharmacy, device or vision products. |
originalPrescription_display | String | The display of the originalPrescription. Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. |
originalPrescription_reference | String | The reference of the originalPrescription. Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. |
originalPrescription_identifier_value | String | The value of the originalPrescription-identifier. Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. |
originalPrescription_type | String | The originalPrescription-type of the originalPrescription-type. Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. |
payee_id | String | The payee-id of the payee-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
payee_extension | String | The payee-extension of the payee-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
payee_modifierExtension | String | The payee-modifierExtension of the payee-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
payee_type_coding | String | The coding of the payee-type. Type of Party to be reimbursed: Subscriber, provider, other. |
payee_type_text | String | The text of the payee-type. Type of Party to be reimbursed: Subscriber, provider, other. |
payee_party_display | String | The display of the payee-party. Reference to the individual or organization to whom any payment will be made. |
payee_party_reference | String | The reference of the payee-party. Reference to the individual or organization to whom any payment will be made. |
payee_party_identifier_value | String | The value of the payee-party-identifier. Reference to the individual or organization to whom any payment will be made. |
payee_party_type | String | The payee-party-type of the payee-party-type. Reference to the individual or organization to whom any payment will be made. |
referral_display | String | The display of the referral. A reference to a referral resource. |
referral_reference | String | The reference of the referral. A reference to a referral resource. |
referral_identifier_value | String | The value of the referral-identifier. A reference to a referral resource. |
referral_type | String | The referral-type of the referral-type. A reference to a referral resource. |
facility_display | String | The display of the facility. Facility where the services were provided. |
facility_reference | String | The reference of the facility. Facility where the services were provided. |
facility_identifier_value | String | The value of the facility-identifier. Facility where the services were provided. |
facility_type | String | The facility-type of the facility-type. Facility where the services were provided. |
claim_display | String | The display of the claim. The business identifier for the instance of the adjudication request: claim predetermination or preauthorization. |
claim_reference | String | The reference of the claim. The business identifier for the instance of the adjudication request: claim predetermination or preauthorization. |
claim_identifier_value | String | The value of the claim-identifier. The business identifier for the instance of the adjudication request: claim predetermination or preauthorization. |
claim_type | String | The claim-type of the claim-type. The business identifier for the instance of the adjudication request: claim predetermination or preauthorization. |
claimResponse_display | String | The display of the claimResponse. The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response. |
claimResponse_reference | String | The reference of the claimResponse. The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response. |
claimResponse_identifier_value | String | The value of the claimResponse-identifier. The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response. |
claimResponse_type | String | The claimResponse-type of the claimResponse-type. The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response. |
outcome | String | The outcome of the claim, predetermination, or preauthorization processing. |
disposition | String | A human readable description of the status of the adjudication. |
preAuthRef | String | Reference from the Insurer which is used in later communications which refers to this adjudication. |
preAuthRefPeriod_start | String | The start of the preAuthRefPeriod. The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided. |
preAuthRefPeriod_end | String | The end of the preAuthRefPeriod. The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided. |
careTeam_id | String | The careTeam-id of the careTeam-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
careTeam_extension | String | The careTeam-extension of the careTeam-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
careTeam_modifierExtension | String | The careTeam-modifierExtension of the careTeam-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
careTeam_sequence | Int | The careTeam-sequence of the careTeam-sequence. A number to uniquely identify care team entries. |
careTeam_provider_display | String | The display of the careTeam-provider. Member of the team who provided the product or service. |
careTeam_provider_reference | String | The reference of the careTeam-provider. Member of the team who provided the product or service. |
careTeam_provider_identifier_value | String | The value of the careTeam-provider-identifier. Member of the team who provided the product or service. |
careTeam_provider_type | String | The careTeam-provider-type of the careTeam-provider-type. Member of the team who provided the product or service. |
careTeam_responsible | Bool | The careTeam-responsible of the careTeam-responsible. The party who is billing and/or responsible for the claimed products or services. |
careTeam_role_coding | String | The coding of the careTeam-role. The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. |
careTeam_role_text | String | The text of the careTeam-role. The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. |
careTeam_qualification_coding | String | The coding of the careTeam-qualification. The qualification of the practitioner which is applicable for this service. |
careTeam_qualification_text | String | The text of the careTeam-qualification. The qualification of the practitioner which is applicable for this service. |
supportingInfo_id | String | The supportingInfo-id of the supportingInfo-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
supportingInfo_extension | String | The supportingInfo-extension of the supportingInfo-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
supportingInfo_modifierExtension | String | The supportingInfo-modifierExtension of the supportingInfo-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
supportingInfo_sequence | Int | The supportingInfo-sequence of the supportingInfo-sequence. A number to uniquely identify supporting information entries. |
supportingInfo_category_coding | String | The coding of the supportingInfo-category. The general class of the information supplied: information; exception; accident, employment; onset, etc. |
supportingInfo_category_text | String | The text of the supportingInfo-category. The general class of the information supplied: information; exception; accident, employment; onset, etc. |
supportingInfo_code_coding | String | The coding of the supportingInfo-code. System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought. |
supportingInfo_code_text | String | The text of the supportingInfo-code. System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought. |
supportingInfo_timing_x_ | Date | The supportingInfo-timing[x] of the supportingInfo-timing[x]. The date when or period to which this information refers. |
supportingInfo_value_x_ | Bool | The supportingInfo-value[x] of the supportingInfo-value[x]. Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
supportingInfo_reason_version | String | The version of the supportingInfo-reason. Provides the reason in the situation where a reason code is required in addition to the content. |
supportingInfo_reason_code | String | The code of the supportingInfo-reason. Provides the reason in the situation where a reason code is required in addition to the content. |
supportingInfo_reason_display | String | The display of the supportingInfo-reason. Provides the reason in the situation where a reason code is required in addition to the content. |
supportingInfo_reason_userSelected | Bool | The userSelected of the supportingInfo-reason. Provides the reason in the situation where a reason code is required in addition to the content. |
supportingInfo_reason_system | String | The supportingInfo-reason-system of the supportingInfo-reason-system. Provides the reason in the situation where a reason code is required in addition to the content. |
diagnosis_id | String | The diagnosis-id of the diagnosis-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
diagnosis_extension | String | The diagnosis-extension of the diagnosis-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
diagnosis_modifierExtension | String | The diagnosis-modifierExtension of the diagnosis-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
diagnosis_sequence | Int | The diagnosis-sequence of the diagnosis-sequence. A number to uniquely identify diagnosis entries. |
diagnosis_diagnosis_x_coding | String | The coding of the diagnosis-diagnosis[x]. The nature of illness or problem in a coded form or as a reference to an external defined Condition. |
diagnosis_diagnosis_x_text | String | The text of the diagnosis-diagnosis[x]. The nature of illness or problem in a coded form or as a reference to an external defined Condition. |
diagnosis_type_coding | String | The coding of the diagnosis-type. When the condition was observed or the relative ranking. |
diagnosis_type_text | String | The text of the diagnosis-type. When the condition was observed or the relative ranking. |
diagnosis_onAdmission_coding | String | The coding of the diagnosis-onAdmission. Indication of whether the diagnosis was present on admission to a facility. |
diagnosis_onAdmission_text | String | The text of the diagnosis-onAdmission. Indication of whether the diagnosis was present on admission to a facility. |
diagnosis_packageCode_coding | String | The coding of the diagnosis-packageCode. A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system. |
diagnosis_packageCode_text | String | The text of the diagnosis-packageCode. A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system. |
procedure_id | String | The procedure-id of the procedure-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
procedure_extension | String | The procedure-extension of the procedure-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
procedure_modifierExtension | String | The procedure-modifierExtension of the procedure-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
procedure_sequence | Int | The procedure-sequence of the procedure-sequence. A number to uniquely identify procedure entries. |
procedure_type_coding | String | The coding of the procedure-type. When the condition was observed or the relative ranking. |
procedure_type_text | String | The text of the procedure-type. When the condition was observed or the relative ranking. |
procedure_date | Datetime | The procedure-date of the procedure-date. Date and optionally time the procedure was performed. |
procedure_procedure_x_coding | String | The coding of the procedure-procedure[x]. The code or reference to a Procedure resource which identifies the clinical intervention performed. |
procedure_procedure_x_text | String | The text of the procedure-procedure[x]. The code or reference to a Procedure resource which identifies the clinical intervention performed. |
procedure_udi_display | String | The display of the procedure-udi. Unique Device Identifiers associated with this line item. |
procedure_udi_reference | String | The reference of the procedure-udi. Unique Device Identifiers associated with this line item. |
procedure_udi_identifier_value | String | The value of the procedure-udi-identifier. Unique Device Identifiers associated with this line item. |
procedure_udi_type | String | The procedure-udi-type of the procedure-udi-type. Unique Device Identifiers associated with this line item. |
precedence | Int | This indicates the relative order of a series of EOBs related to different coverages for the same suite of services. |
insurance_id | String | The insurance-id of the insurance-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
insurance_extension | String | The insurance-extension of the insurance-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
insurance_modifierExtension | String | The insurance-modifierExtension of the insurance-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
insurance_focal | Bool | The insurance-focal of the insurance-focal. A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. |
insurance_coverage_display | String | The display of the insurance-coverage. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_coverage_reference | String | The reference of the insurance-coverage. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_coverage_identifier_value | String | The value of the insurance-coverage-identifier. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_coverage_type | String | The insurance-coverage-type of the insurance-coverage-type. Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
insurance_preAuthRef | String | The insurance-preAuthRef of the insurance-preAuthRef. Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization. |
accident_id | String | The accident-id of the accident-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
accident_extension | String | The accident-extension of the accident-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
accident_modifierExtension | String | The accident-modifierExtension of the accident-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
accident_date | Date | The accident-date of the accident-date. Date of an accident event related to the products and services contained in the claim. |
accident_type_coding | String | The coding of the accident-type. The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers. |
accident_type_text | String | The text of the accident-type. The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers. |
accident_location_x_text | String | The text of the accident-location[x]. The physical location of the accident event. |
accident_location_x_line | String | The line of the accident-location[x]. The physical location of the accident event. |
accident_location_x_city | String | The city of the accident-location[x]. The physical location of the accident event. |
accident_location_x_district | String | The district of the accident-location[x]. The physical location of the accident event. |
accident_location_x_state | String | The state of the accident-location[x]. The physical location of the accident event. |
accident_location_x_postalCode | String | The postalCode of the accident-location[x]. The physical location of the accident event. |
accident_location_x_country | String | The country of the accident-location[x]. The physical location of the accident event. |
accident_location_x_type | String | The accident-location[x]-type of the accident-location[x]-type. The physical location of the accident event. |
accident_location_x_period_start | Datetime | The start of the accident-location[x]-period. The physical location of the accident event. |
accident_location_x_period_end | Datetime | The end of the accident-location[x]-period. The physical location of the accident event. |
accident_location_x_use | String | The accident-location[x]-use of the accident-location[x]-use. The physical location of the accident event. |
item_id | String | The item-id of the item-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_extension | String | The item-extension of the item-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_modifierExtension | String | The item-modifierExtension of the item-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_sequence | Int | The item-sequence of the item-sequence. A number to uniquely identify item entries. |
item_careTeamSequence | String | The item-careTeamSequence of the item-careTeamSequence. Care team members related to this service or product. |
item_diagnosisSequence | String | The item-diagnosisSequence of the item-diagnosisSequence. Diagnoses applicable for this service or product. |
item_procedureSequence | String | The item-procedureSequence of the item-procedureSequence. Procedures applicable for this service or product. |
item_informationSequence | String | The item-informationSequence of the item-informationSequence. Exceptions, special conditions and supporting information applicable for this service or product. |
item_revenue_coding | String | The coding of the item-revenue. The type of revenue or cost center providing the product and/or service. |
item_revenue_text | String | The text of the item-revenue. The type of revenue or cost center providing the product and/or service. |
item_category_coding | String | The coding of the item-category. Code to identify the general type of benefits under which products and services are provided. |
item_category_text | String | The text of the item-category. Code to identify the general type of benefits under which products and services are provided. |
item_productOrService_coding | String | The coding of the item-productOrService. When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
item_productOrService_text | String | The text of the item-productOrService. When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
item_modifier_coding | String | The coding of the item-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
item_modifier_text | String | The text of the item-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
item_programCode_coding | String | The coding of the item-programCode. Identifies the program under which this may be recovered. |
item_programCode_text | String | The text of the item-programCode. Identifies the program under which this may be recovered. |
item_serviced_x_ | Date | The item-serviced[x] of the item-serviced[x]. The date or dates when the service or product was supplied, performed or completed. |
item_location_x_coding | String | The coding of the item-location[x]. Where the product or service was provided. |
item_location_x_text | String | The text of the item-location[x]. Where the product or service was provided. |
item_quantity_value | Decimal | The value of the item-quantity. The number of repetitions of a service or product. |
item_quantity_unit | String | The unit of the item-quantity. The number of repetitions of a service or product. |
item_quantity_system | String | The system of the item-quantity. The number of repetitions of a service or product. |
item_quantity_comparator | String | The item-quantity-comparator of the item-quantity-comparator. The number of repetitions of a service or product. |
item_quantity_code | String | The item-quantity-code of the item-quantity-code. The number of repetitions of a service or product. |
item_unitPrice | String | The item-unitPrice of the item-unitPrice. If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. |
item_factor | Decimal | The item-factor of the item-factor. A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
item_net | String | The item-net of the item-net. The quantity times the unit price for an additional service or product or charge. |
item_udi_display | String | The display of the item-udi. Unique Device Identifiers associated with this line item. |
item_udi_reference | String | The reference of the item-udi. Unique Device Identifiers associated with this line item. |
item_udi_identifier_value | String | The value of the item-udi-identifier. Unique Device Identifiers associated with this line item. |
item_udi_type | String | The item-udi-type of the item-udi-type. Unique Device Identifiers associated with this line item. |
item_bodySite_coding | String | The coding of the item-bodySite. Physical service site on the patient (limb, tooth, etc.). |
item_bodySite_text | String | The text of the item-bodySite. Physical service site on the patient (limb, tooth, etc.). |
item_subSite_coding | String | The coding of the item-subSite. A region or surface of the bodySite, e.g. limb region or tooth surface(s). |
item_subSite_text | String | The text of the item-subSite. A region or surface of the bodySite, e.g. limb region or tooth surface(s). |
item_encounter_display | String | The display of the item-encounter. A billed item may include goods or services provided in multiple encounters. |
item_encounter_reference | String | The reference of the item-encounter. A billed item may include goods or services provided in multiple encounters. |
item_encounter_identifier_value | String | The value of the item-encounter-identifier. A billed item may include goods or services provided in multiple encounters. |
item_encounter_type | String | The item-encounter-type of the item-encounter-type. A billed item may include goods or services provided in multiple encounters. |
item_noteNumber | String | The item-noteNumber of the item-noteNumber. The numbers associated with notes below which apply to the adjudication of this item. |
item_adjudication_id | String | The item-adjudication-id of the item-adjudication-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_adjudication_extension | String | The item-adjudication-extension of the item-adjudication-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_adjudication_modifierExtension | String | The item-adjudication-modifierExtension of the item-adjudication-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_adjudication_category_coding | String | The coding of the item-adjudication-category. A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. |
item_adjudication_category_text | String | The text of the item-adjudication-category. A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item. |
item_adjudication_reason_coding | String | The coding of the item-adjudication-reason. A code supporting the understanding of the adjudication result and explaining variance from expected amount. |
item_adjudication_reason_text | String | The text of the item-adjudication-reason. A code supporting the understanding of the adjudication result and explaining variance from expected amount. |
item_adjudication_amount | String | The item-adjudication-amount of the item-adjudication-amount. Monetary amount associated with the category. |
item_adjudication_value | Decimal | The item-adjudication-value of the item-adjudication-value. A non-monetary value associated with the category. Mutually exclusive to the amount element above. |
item_detail_id | String | The item-detail-id of the item-detail-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_detail_extension | String | The item-detail-extension of the item-detail-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_detail_modifierExtension | String | The item-detail-modifierExtension of the item-detail-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_detail_sequence | Int | The item-detail-sequence of the item-detail-sequence. A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. |
item_detail_revenue_coding | String | The coding of the item-detail-revenue. The type of revenue or cost center providing the product and/or service. |
item_detail_revenue_text | String | The text of the item-detail-revenue. The type of revenue or cost center providing the product and/or service. |
item_detail_category_coding | String | The coding of the item-detail-category. Code to identify the general type of benefits under which products and services are provided. |
item_detail_category_text | String | The text of the item-detail-category. Code to identify the general type of benefits under which products and services are provided. |
item_detail_productOrService_coding | String | The coding of the item-detail-productOrService. When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
item_detail_productOrService_text | String | The text of the item-detail-productOrService. When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
item_detail_modifier_coding | String | The coding of the item-detail-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
item_detail_modifier_text | String | The text of the item-detail-modifier. Item typification or modifiers codes to convey additional context for the product or service. |
item_detail_programCode_coding | String | The coding of the item-detail-programCode. Identifies the program under which this may be recovered. |
item_detail_programCode_text | String | The text of the item-detail-programCode. Identifies the program under which this may be recovered. |
item_detail_quantity_value | Decimal | The value of the item-detail-quantity. The number of repetitions of a service or product. |
item_detail_quantity_unit | String | The unit of the item-detail-quantity. The number of repetitions of a service or product. |
item_detail_quantity_system | String | The system of the item-detail-quantity. The number of repetitions of a service or product. |
item_detail_quantity_comparator | String | The item-detail-quantity-comparator of the item-detail-quantity-comparator. The number of repetitions of a service or product. |
item_detail_quantity_code | String | The item-detail-quantity-code of the item-detail-quantity-code. The number of repetitions of a service or product. |
item_detail_unitPrice | String | The item-detail-unitPrice of the item-detail-unitPrice. If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. |
item_detail_factor | Decimal | The item-detail-factor of the item-detail-factor. A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
item_detail_net | String | The item-detail-net of the item-detail-net. The quantity times the unit price for an additional service or product or charge. |
item_detail_udi_display | String | The display of the item-detail-udi. Unique Device Identifiers associated with this line item. |
item_detail_udi_reference | String | The reference of the item-detail-udi. Unique Device Identifiers associated with this line item. |
item_detail_udi_identifier_value | String | The value of the item-detail-udi-identifier. Unique Device Identifiers associated with this line item. |
item_detail_udi_type | String | The item-detail-udi-type of the item-detail-udi-type. Unique Device Identifiers associated with this line item. |
item_detail_noteNumber | String | The item-detail-noteNumber of the item-detail-noteNumber. The numbers associated with notes below which apply to the adjudication of this item. |
SP_source | String | The SP_source search parameter. |
SP_facility | String | The SP_facility search parameter. |
SP_text | String | The SP_text search parameter. |
SP_coverage | String | The SP_coverage search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_procedure_udi | String | The SP_procedure_udi search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_claim | String | The SP_claim search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_detail_udi | String | The SP_detail_udi search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_enterer | String | The SP_enterer search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_care_team | String | The SP_care_team search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_payee | String | The SP_payee search parameter. |
SP_subdetail_udi | String | The SP_subdetail_udi search parameter. |
SP_item_udi | String | The SP_item_udi search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_provider | String | The SP_provider search parameter. |
FamilyMemberHistory view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
instantiatesCanonical | String | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. |
instantiatesUri | String | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. |
status | String | A code specifying the status of the record of the family history of a specific family member. |
dataAbsentReason_coding | String | The coding of the dataAbsentReason. Describes why the family member's history is not available. |
dataAbsentReason_text | String | The text of the dataAbsentReason. Describes why the family member's history is not available. |
patient_display | String | The display of the patient. The person who this history concerns. |
patient_reference | String | The reference of the patient. The person who this history concerns. |
patient_identifier_value | String | The value of the patient-identifier. The person who this history concerns. |
patient_type | String | The patient-type of the patient-type. The person who this history concerns. |
date | Datetime | The date (and possibly time) when the family member history was recorded or last updated. |
name | String | This will either be a name or a description; e.g. 'Aunt Susan', 'my cousin with the red hair'. |
relationship_coding | String | The coding of the relationship. The type of relationship this person has to the patient (father, mother, brother etc.). |
relationship_text | String | The text of the relationship. The type of relationship this person has to the patient (father, mother, brother etc.). |
sex_coding | String | The coding of the sex. The birth sex of the family member. |
sex_text | String | The text of the sex. The birth sex of the family member. |
born_x_start | Datetime | The start of the born[x]. The actual or approximate date of birth of the relative. |
born_x_end | Datetime | The end of the born[x]. The actual or approximate date of birth of the relative. |
age_x_ | String | The age of the relative at the time the family member history is recorded. |
estimatedAge | Bool | If true, indicates that the age value specified is an estimated value. |
deceased_x_ | Bool | Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record. |
reasonCode_coding | String | The coding of the reasonCode. Describes why the family member history occurred in coded or textual form. |
reasonCode_text | String | The text of the reasonCode. Describes why the family member history occurred in coded or textual form. |
reasonReference_display | String | The display of the reasonReference. Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. |
reasonReference_reference | String | The reference of the reasonReference. Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. |
note | String | This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible. |
condition_id | String | The condition-id of the condition-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
condition_extension | String | The condition-extension of the condition-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
condition_modifierExtension | String | The condition-modifierExtension of the condition-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
condition_code_coding | String | The coding of the condition-code. The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system. |
condition_code_text | String | The text of the condition-code. The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system. |
condition_outcome_coding | String | The coding of the condition-outcome. Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. |
condition_outcome_text | String | The text of the condition-outcome. Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. |
condition_contributedToDeath | Bool | The condition-contributedToDeath of the condition-contributedToDeath. This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown. |
condition_onset_x_ | String | The condition-onset[x] of the condition-onset[x]. Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence. |
condition_note | String | The condition-note of the condition-note. An area where general notes can be placed about this specific condition. |
SP_relationship_start | String | The SP_relationship_start search parameter. |
SP_source | String | The SP_source search parameter. |
SP_relationship_end | String | The SP_relationship_end search parameter. |
SP_instantiates_canonical | String | The SP_instantiates_canonical search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_sex_start | String | The SP_sex_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_instantiates_uri | String | The SP_instantiates_uri search parameter. |
SP_familymemberhistorycondition_end | String | The SP_familymemberhistorycondition_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_familymemberhistorycondition_start | String | The SP_familymemberhistorycondition_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_sex_end | String | The SP_sex_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
Flag view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
status | String | Supports basic workflow. |
category_coding | String | The coding of the category. Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context. |
category_text | String | The text of the category. Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context. |
code_coding | String | The coding of the code. The coded value or textual component of the flag to display to the user. |
code_text | String | The text of the code. The coded value or textual component of the flag to display to the user. |
subject_display | String | The display of the subject. The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with. |
subject_reference | String | The reference of the subject. The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with. |
subject_identifier_value | String | The value of the subject-identifier. The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with. |
subject_type | String | The subject-type of the subject-type. The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with. |
period_start | Datetime | The start of the period. The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified. |
period_end | Datetime | The end of the period. The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified. |
encounter_display | String | The display of the encounter. This alert is only relevant during the encounter. |
encounter_reference | String | The reference of the encounter. This alert is only relevant during the encounter. |
encounter_identifier_value | String | The value of the encounter-identifier. This alert is only relevant during the encounter. |
encounter_type | String | The encounter-type of the encounter-type. This alert is only relevant during the encounter. |
author_display | String | The display of the author. The person, organization or device that created the flag. |
author_reference | String | The reference of the author. The person, organization or device that created the flag. |
author_identifier_value | String | The value of the author-identifier. The person, organization or device that created the flag. |
author_type | String | The author-type of the author-type. The person, organization or device that created the flag. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_author | String | The SP_author search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_date | String | The SP_date search parameter. |
Goal view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
lifecycleStatus | String | The state of the goal throughout its lifecycle. |
achievementStatus_coding | String | The coding of the achievementStatus. Describes the progression, or lack thereof, towards the goal against the target. |
achievementStatus_text | String | The text of the achievementStatus. Describes the progression, or lack thereof, towards the goal against the target. |
category_coding | String | The coding of the category. Indicates a category the goal falls within. |
category_text | String | The text of the category. Indicates a category the goal falls within. |
priority_coding | String | The coding of the priority. Identifies the mutually agreed level of importance associated with reaching/sustaining the goal. |
priority_text | String | The text of the priority. Identifies the mutually agreed level of importance associated with reaching/sustaining the goal. |
description_coding | String | The coding of the description. Human-readable and/or coded description of a specific desired objective of care, such as 'control blood pressure' or 'negotiate an obstacle course' or 'dance with child at wedding'. |
description_text | String | The text of the description. Human-readable and/or coded description of a specific desired objective of care, such as 'control blood pressure' or 'negotiate an obstacle course' or 'dance with child at wedding'. |
subject_display | String | The display of the subject. Identifies the patient, group or organization for whom the goal is being established. |
subject_reference | String | The reference of the subject. Identifies the patient, group or organization for whom the goal is being established. |
subject_identifier_value | String | The value of the subject-identifier. Identifies the patient, group or organization for whom the goal is being established. |
subject_type | String | The subject-type of the subject-type. Identifies the patient, group or organization for whom the goal is being established. |
start_x_ | Date | The date or event after which the goal should begin being pursued. |
target_id | String | The target-id of the target-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
target_extension | String | The target-extension of the target-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
target_modifierExtension | String | The target-modifierExtension of the target-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
target_measure_coding | String | The coding of the target-measure. The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. |
target_measure_text | String | The text of the target-measure. The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. |
target_detail_x_value | Decimal | The value of the target-detail[x]. The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value. |
target_detail_x_unit | String | The unit of the target-detail[x]. The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value. |
target_detail_x_system | String | The system of the target-detail[x]. The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value. |
target_detail_x_comparator | String | The target-detail[x]-comparator of the target-detail[x]-comparator. The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value. |
target_detail_x_code | String | The target-detail[x]-code of the target-detail[x]-code. The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value. |
target_due_x_ | Date | The target-due[x] of the target-due[x]. Indicates either the date or the duration after start by which the goal should be met. |
statusDate | Date | Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc. |
statusReason | String | Captures the reason for the current status. |
expressedBy_display | String | The display of the expressedBy. Indicates whose goal this is - patient goal, practitioner goal, etc. |
expressedBy_reference | String | The reference of the expressedBy. Indicates whose goal this is - patient goal, practitioner goal, etc. |
expressedBy_identifier_value | String | The value of the expressedBy-identifier. Indicates whose goal this is - patient goal, practitioner goal, etc. |
expressedBy_type | String | The expressedBy-type of the expressedBy-type. Indicates whose goal this is - patient goal, practitioner goal, etc. |
addresses_display | String | The display of the addresses. The identified conditions and other health record elements that are intended to be addressed by the goal. |
addresses_reference | String | The reference of the addresses. The identified conditions and other health record elements that are intended to be addressed by the goal. |
addresses_identifier_value | String | The value of the addresses-identifier. The identified conditions and other health record elements that are intended to be addressed by the goal. |
addresses_type | String | The addresses-type of the addresses-type. The identified conditions and other health record elements that are intended to be addressed by the goal. |
note | String | Any comments related to the goal. |
outcomeCode_coding | String | The coding of the outcomeCode. Identifies the change (or lack of change) at the point when the status of the goal is assessed. |
outcomeCode_text | String | The text of the outcomeCode. Identifies the change (or lack of change) at the point when the status of the goal is assessed. |
outcomeReference_display | String | The display of the outcomeReference. Details of what's changed (or not changed). |
outcomeReference_reference | String | The reference of the outcomeReference. Details of what's changed (or not changed). |
outcomeReference_identifier_value | String | The value of the outcomeReference-identifier. Details of what's changed (or not changed). |
outcomeReference_type | String | The outcomeReference-type of the outcomeReference-type. Details of what's changed (or not changed). |
SP_target_date | String | The SP_target_date search parameter. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_achievement_status_end | String | The SP_achievement_status_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_start_date | String | The SP_start_date search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_lifecycle_status_start | String | The SP_lifecycle_status_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_lifecycle_status_end | String | The SP_lifecycle_status_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_achievement_status_start | String | The SP_achievement_status_start search parameter. |
Group view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique business identifier for this group. |
identifier_use | String | The identifier-use of the identifier-use. A unique business identifier for this group. |
identifier_type_coding | String | The coding of the identifier-type. A unique business identifier for this group. |
identifier_type_text | String | The text of the identifier-type. A unique business identifier for this group. |
identifier_system | String | The identifier-system of the identifier-system. A unique business identifier for this group. |
identifier_period_start | String | The start of the identifier-period. A unique business identifier for this group. |
identifier_period_end | String | The end of the identifier-period. A unique business identifier for this group. |
active | Bool | Indicates whether the record for the group is available for use or is merely being retained for historical purposes. |
type | String | Identifies the broad classification of the kind of resources the group includes. |
actual | Bool | If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals. |
code_coding | String | The coding of the code. Provides a specific type of resource the group includes; e.g. 'cow', 'syringe', etc. |
code_text | String | The text of the code. Provides a specific type of resource the group includes; e.g. 'cow', 'syringe', etc. |
name | String | A label assigned to the group for human identification and communication. |
quantity | String | A count of the number of resource instances that are part of the group. |
managingEntity_display | String | The display of the managingEntity. Entity responsible for defining and maintaining Group characteristics and/or registered members. |
managingEntity_reference | String | The reference of the managingEntity. Entity responsible for defining and maintaining Group characteristics and/or registered members. |
managingEntity_identifier_value | String | The value of the managingEntity-identifier. Entity responsible for defining and maintaining Group characteristics and/or registered members. |
managingEntity_type | String | The managingEntity-type of the managingEntity-type. Entity responsible for defining and maintaining Group characteristics and/or registered members. |
characteristic_id | String | The characteristic-id of the characteristic-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
characteristic_extension | String | The characteristic-extension of the characteristic-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
characteristic_modifierExtension | String | The characteristic-modifierExtension of the characteristic-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
characteristic_code_coding | String | The coding of the characteristic-code. A code that identifies the kind of trait being asserted. |
characteristic_code_text | String | The text of the characteristic-code. A code that identifies the kind of trait being asserted. |
characteristic_value_x_coding | String | The coding of the characteristic-value[x]. The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
characteristic_value_x_text | String | The text of the characteristic-value[x]. The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
characteristic_exclude | Bool | The characteristic-exclude of the characteristic-exclude. If true, indicates the characteristic is one that is NOT held by members of the group. |
characteristic_period_start | Datetime | The start of the characteristic-period. The period over which the characteristic is tested; e.g. the patient had an operation during the month of June. |
characteristic_period_end | Datetime | The end of the characteristic-period. The period over which the characteristic is tested; e.g. the patient had an operation during the month of June. |
member_id | String | The member-id of the member-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
member_extension | String | The member-extension of the member-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
member_modifierExtension | String | The member-modifierExtension of the member-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
member_entity_display | String | The display of the member-entity. A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same. |
member_entity_reference | String | The reference of the member-entity. A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same. |
member_entity_identifier_value | String | The value of the member-entity-identifier. A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same. |
member_entity_type | String | The member-entity-type of the member-entity-type. A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same. |
member_period_start | Datetime | The start of the member-period. The period that the member was in the group, if known. |
member_period_end | Datetime | The end of the member-period. The period that the member was in the group, if known. |
member_inactive | Bool | The member-inactive of the member-inactive. A flag to indicate that the member is no longer in the group, but previously may have been a member. |
SP_source | String | The SP_source search parameter. |
SP_characteristic_start | String | The SP_characteristic_start search parameter. |
SP_member | String | The SP_member search parameter. |
SP_text | String | The SP_text search parameter. |
SP_characteristic_value | String | The SP_characteristic_value search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_exclude_start | String | The SP_exclude_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_value_start | String | The SP_value_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_characteristic_end | String | The SP_characteristic_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_value_end | String | The SP_value_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_exclude_end | String | The SP_exclude_end search parameter. |
SP_managing_entity | String | The SP_managing_entity search parameter. |
GuidanceResponse view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
requestIdentifier_value | String | The value of the requestIdentifier. The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario. |
requestIdentifier_use | String | The requestIdentifier-use of the requestIdentifier-use. The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario. |
requestIdentifier_type_coding | String | The coding of the requestIdentifier-type. The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario. |
requestIdentifier_type_text | String | The text of the requestIdentifier-type. The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario. |
requestIdentifier_system | String | The requestIdentifier-system of the requestIdentifier-system. The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario. |
requestIdentifier_period_start | Datetime | The start of the requestIdentifier-period. The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario. |
requestIdentifier_period_end | Datetime | The end of the requestIdentifier-period. The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario. |
identifier_value | String | The value of the identifier. Allows a service to provide unique, business identifiers for the response. |
identifier_use | String | The identifier-use of the identifier-use. Allows a service to provide unique, business identifiers for the response. |
identifier_type_coding | String | The coding of the identifier-type. Allows a service to provide unique, business identifiers for the response. |
identifier_type_text | String | The text of the identifier-type. Allows a service to provide unique, business identifiers for the response. |
identifier_system | String | The identifier-system of the identifier-system. Allows a service to provide unique, business identifiers for the response. |
identifier_period_start | String | The start of the identifier-period. Allows a service to provide unique, business identifiers for the response. |
identifier_period_end | String | The end of the identifier-period. Allows a service to provide unique, business identifiers for the response. |
module_x_ | String | An identifier, CodeableConcept or canonical reference to the guidance that was requested. |
status | String | The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information. |
subject_display | String | The display of the subject. The patient for which the request was processed. |
subject_reference | String | The reference of the subject. The patient for which the request was processed. |
subject_identifier_value | String | The value of the subject-identifier. The patient for which the request was processed. |
subject_type | String | The subject-type of the subject-type. The patient for which the request was processed. |
encounter_display | String | The display of the encounter. The encounter during which this response was created or to which the creation of this record is tightly associated. |
encounter_reference | String | The reference of the encounter. The encounter during which this response was created or to which the creation of this record is tightly associated. |
encounter_identifier_value | String | The value of the encounter-identifier. The encounter during which this response was created or to which the creation of this record is tightly associated. |
encounter_type | String | The encounter-type of the encounter-type. The encounter during which this response was created or to which the creation of this record is tightly associated. |
occurrenceDateTime | Datetime | Indicates when the guidance response was processed. |
performer_display | String | The display of the performer. Provides a reference to the device that performed the guidance. |
performer_reference | String | The reference of the performer. Provides a reference to the device that performed the guidance. |
performer_identifier_value | String | The value of the performer-identifier. Provides a reference to the device that performed the guidance. |
performer_type | String | The performer-type of the performer-type. Provides a reference to the device that performed the guidance. |
reasonCode_coding | String | The coding of the reasonCode. Describes the reason for the guidance response in coded or textual form. |
reasonCode_text | String | The text of the reasonCode. Describes the reason for the guidance response in coded or textual form. |
reasonReference_display | String | The display of the reasonReference. Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response. |
reasonReference_reference | String | The reference of the reasonReference. Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response. |
note | String | Provides a mechanism to communicate additional information about the response. |
evaluationMessage_display | String | The display of the evaluationMessage. Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element. |
evaluationMessage_reference | String | The reference of the evaluationMessage. Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element. |
evaluationMessage_identifier_value | String | The value of the evaluationMessage-identifier. Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element. |
evaluationMessage_type | String | The evaluationMessage-type of the evaluationMessage-type. Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element. |
outputParameters_display | String | The display of the outputParameters. The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element. |
outputParameters_reference | String | The reference of the outputParameters. The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element. |
outputParameters_identifier_value | String | The value of the outputParameters-identifier. The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element. |
outputParameters_type | String | The outputParameters-type of the outputParameters-type. The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element. |
result_display | String | The display of the result. The actions, if any, produced by the evaluation of the artifact. |
result_reference | String | The reference of the result. The actions, if any, produced by the evaluation of the artifact. |
result_identifier_value | String | The value of the result-identifier. The actions, if any, produced by the evaluation of the artifact. |
result_type | String | The result-type of the result-type. The actions, if any, produced by the evaluation of the artifact. |
dataRequirement | String | If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_request_end | String | The SP_request_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_request_start | String | The SP_request_start search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
HealthcareService view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. External identifiers for this item. |
identifier_use | String | The identifier-use of the identifier-use. External identifiers for this item. |
identifier_type_coding | String | The coding of the identifier-type. External identifiers for this item. |
identifier_type_text | String | The text of the identifier-type. External identifiers for this item. |
identifier_system | String | The identifier-system of the identifier-system. External identifiers for this item. |
identifier_period_start | String | The start of the identifier-period. External identifiers for this item. |
identifier_period_end | String | The end of the identifier-period. External identifiers for this item. |
active | Bool | This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. |
providedBy_display | String | The display of the providedBy. The organization that provides this healthcare service. |
providedBy_reference | String | The reference of the providedBy. The organization that provides this healthcare service. |
providedBy_identifier_value | String | The value of the providedBy-identifier. The organization that provides this healthcare service. |
providedBy_type | String | The providedBy-type of the providedBy-type. The organization that provides this healthcare service. |
category_coding | String | The coding of the category. Identifies the broad category of service being performed or delivered. |
category_text | String | The text of the category. Identifies the broad category of service being performed or delivered. |
type_coding | String | The coding of the type. The specific type of service that may be delivered or performed. |
type_text | String | The text of the type. The specific type of service that may be delivered or performed. |
specialty_coding | String | The coding of the specialty. Collection of specialties handled by the service site. This is more of a medical term. |
specialty_text | String | The text of the specialty. Collection of specialties handled by the service site. This is more of a medical term. |
location_display | String | The display of the location. The location(s) where this healthcare service may be provided. |
location_reference | String | The reference of the location. The location(s) where this healthcare service may be provided. |
location_identifier_value | String | The value of the location-identifier. The location(s) where this healthcare service may be provided. |
location_type | String | The location-type of the location-type. The location(s) where this healthcare service may be provided. |
name | String | Further description of the service as it would be presented to a consumer while searching. |
comment | String | Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. |
extraDetails | String | Extra details about the service that can't be placed in the other fields. |
photo_data | String | The data of the photo. If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. |
photo_url | String | The url of the photo. If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. |
photo_size | Int | The size of the photo. If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. |
photo_title | String | The title of the photo. If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. |
photo_creation | Datetime | The creation of the photo. If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. |
photo_height | Int | The height of the photo. If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. |
photo_width | Int | The width of the photo. If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. |
photo_frames | Int | The frames of the photo. If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. |
photo_duration | Decimal | The duration of the photo. If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. |
photo_pages | Int | The pages of the photo. If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. |
photo_contentType | String | The photo-contentType of the photo-contentType. If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. |
photo_language | String | The photo-language of the photo-language. If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. |
telecom_value | String | The value of the telecom. List of contacts related to this specific healthcare service. |
telecom_system | String | The telecom-system of the telecom-system. List of contacts related to this specific healthcare service. |
telecom_use | String | The telecom-use of the telecom-use. List of contacts related to this specific healthcare service. |
telecom_rank | String | The telecom-rank of the telecom-rank. List of contacts related to this specific healthcare service. |
telecom_period_start | String | The start of the telecom-period. List of contacts related to this specific healthcare service. |
telecom_period_end | String | The end of the telecom-period. List of contacts related to this specific healthcare service. |
coverageArea_display | String | The display of the coverageArea. The location(s) that this service is available to (not where the service is provided). |
coverageArea_reference | String | The reference of the coverageArea. The location(s) that this service is available to (not where the service is provided). |
coverageArea_identifier_value | String | The value of the coverageArea-identifier. The location(s) that this service is available to (not where the service is provided). |
coverageArea_type | String | The coverageArea-type of the coverageArea-type. The location(s) that this service is available to (not where the service is provided). |
serviceProvisionCode_coding | String | The coding of the serviceProvisionCode. The code(s) that detail the conditions under which the healthcare service is available/offered. |
serviceProvisionCode_text | String | The text of the serviceProvisionCode. The code(s) that detail the conditions under which the healthcare service is available/offered. |
eligibility_id | String | The eligibility-id of the eligibility-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
eligibility_extension | String | The eligibility-extension of the eligibility-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
eligibility_modifierExtension | String | The eligibility-modifierExtension of the eligibility-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
eligibility_code_coding | String | The coding of the eligibility-code. Coded value for the eligibility. |
eligibility_code_text | String | The text of the eligibility-code. Coded value for the eligibility. |
eligibility_comment | String | The eligibility-comment of the eligibility-comment. Describes the eligibility conditions for the service. |
program_coding | String | The coding of the program. Programs that this service is applicable to. |
program_text | String | The text of the program. Programs that this service is applicable to. |
characteristic_coding | String | The coding of the characteristic. Collection of characteristics (attributes). |
characteristic_text | String | The text of the characteristic. Collection of characteristics (attributes). |
communication_coding | String | The coding of the communication. Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. |
communication_text | String | The text of the communication. Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. |
referralMethod_coding | String | The coding of the referralMethod. Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. |
referralMethod_text | String | The text of the referralMethod. Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. |
appointmentRequired | Bool | Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service. |
availableTime_id | String | The availableTime-id of the availableTime-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
availableTime_extension | String | The availableTime-extension of the availableTime-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
availableTime_modifierExtension | String | The availableTime-modifierExtension of the availableTime-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
availableTime_daysOfWeek | String | The availableTime-daysOfWeek of the availableTime-daysOfWeek. Indicates which days of the week are available between the start and end Times. |
availableTime_allDay | Bool | The availableTime-allDay of the availableTime-allDay. Is this always available? (hence times are irrelevant) e.g. 24 hour service. |
availableTime_availableStartTime | Time | The availableTime-availableStartTime of the availableTime-availableStartTime. The opening time of day. Note: If the AllDay flag is set, then this time is ignored. |
availableTime_availableEndTime | Time | The availableTime-availableEndTime of the availableTime-availableEndTime. The closing time of day. Note: If the AllDay flag is set, then this time is ignored. |
notAvailable_id | String | The notAvailable-id of the notAvailable-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
notAvailable_extension | String | The notAvailable-extension of the notAvailable-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
notAvailable_modifierExtension | String | The notAvailable-modifierExtension of the notAvailable-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
notAvailable_description | String | The notAvailable-description of the notAvailable-description. The reason that can be presented to the user as to why this time is not available. |
notAvailable_during_start | Datetime | The start of the notAvailable-during. Service is not available (seasonally or for a public holiday) from this date. |
notAvailable_during_end | Datetime | The end of the notAvailable-during. Service is not available (seasonally or for a public holiday) from this date. |
availabilityExceptions | String | A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. |
endpoint_display | String | The display of the endpoint. Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. |
endpoint_reference | String | The reference of the endpoint. Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. |
endpoint_identifier_value | String | The value of the endpoint-identifier. Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. |
endpoint_type | String | The endpoint-type of the endpoint-type. Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. |
SP_location | String | The SP_location search parameter. |
SP_source | String | The SP_source search parameter. |
SP_characteristic_start | String | The SP_characteristic_start search parameter. |
SP_coverage_area | String | The SP_coverage_area search parameter. |
SP_text | String | The SP_text search parameter. |
SP_service_category_end | String | The SP_service_category_end search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_specialty_end | String | The SP_specialty_end search parameter. |
SP_endpoint | String | The SP_endpoint search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_program_end | String | The SP_program_end search parameter. |
SP_service_category_start | String | The SP_service_category_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_specialty_start | String | The SP_specialty_start search parameter. |
SP_service_type_start | String | The SP_service_type_start search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_characteristic_end | String | The SP_characteristic_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_service_type_end | String | The SP_service_type_end search parameter. |
SP_program_start | String | The SP_program_start search parameter. |
SP_organization | String | The SP_organization search parameter. |
ImagingStudy view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. |
identifier_use | String | The identifier-use of the identifier-use. Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. |
identifier_type_coding | String | The coding of the identifier-type. Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. |
identifier_type_text | String | The text of the identifier-type. Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. |
identifier_system | String | The identifier-system of the identifier-system. Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. |
identifier_period_start | String | The start of the identifier-period. Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. |
identifier_period_end | String | The end of the identifier-period. Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. |
status | String | The current state of the ImagingStudy. |
modality_version | String | The version of the modality. A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19). |
modality_code | String | The code of the modality. A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19). |
modality_display | String | The display of the modality. A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19). |
modality_userSelected | String | The userSelected of the modality. A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19). |
modality_system | String | The modality-system of the modality-system. A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19). |
subject_display | String | The display of the subject. The subject, typically a patient, of the imaging study. |
subject_reference | String | The reference of the subject. The subject, typically a patient, of the imaging study. |
subject_identifier_value | String | The value of the subject-identifier. The subject, typically a patient, of the imaging study. |
subject_type | String | The subject-type of the subject-type. The subject, typically a patient, of the imaging study. |
encounter_display | String | The display of the encounter. The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made. |
encounter_reference | String | The reference of the encounter. The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made. |
encounter_identifier_value | String | The value of the encounter-identifier. The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made. |
encounter_type | String | The encounter-type of the encounter-type. The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made. |
started | Datetime | Date and time the study started. |
basedOn_display | String | The display of the basedOn. A list of the diagnostic requests that resulted in this imaging study being performed. |
basedOn_reference | String | The reference of the basedOn. A list of the diagnostic requests that resulted in this imaging study being performed. |
basedOn_identifier_value | String | The value of the basedOn-identifier. A list of the diagnostic requests that resulted in this imaging study being performed. |
basedOn_type | String | The basedOn-type of the basedOn-type. A list of the diagnostic requests that resulted in this imaging study being performed. |
referrer_display | String | The display of the referrer. The requesting/referring physician. |
referrer_reference | String | The reference of the referrer. The requesting/referring physician. |
referrer_identifier_value | String | The value of the referrer-identifier. The requesting/referring physician. |
referrer_type | String | The referrer-type of the referrer-type. The requesting/referring physician. |
interpreter_display | String | The display of the interpreter. Who read the study and interpreted the images or other content. |
interpreter_reference | String | The reference of the interpreter. Who read the study and interpreted the images or other content. |
interpreter_identifier_value | String | The value of the interpreter-identifier. Who read the study and interpreted the images or other content. |
interpreter_type | String | The interpreter-type of the interpreter-type. Who read the study and interpreted the images or other content. |
endpoint_display | String | The display of the endpoint. The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType. |
endpoint_reference | String | The reference of the endpoint. The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType. |
endpoint_identifier_value | String | The value of the endpoint-identifier. The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType. |
endpoint_type | String | The endpoint-type of the endpoint-type. The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType. |
numberOfSeries | String | Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present. |
numberOfInstances | String | Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present. |
procedureReference_display | String | The display of the procedureReference. The procedure which this ImagingStudy was part of. |
procedureReference_reference | String | The reference of the procedureReference. The procedure which this ImagingStudy was part of. |
procedureReference_identifier_value | String | The value of the procedureReference-identifier. The procedure which this ImagingStudy was part of. |
procedureReference_type | String | The procedureReference-type of the procedureReference-type. The procedure which this ImagingStudy was part of. |
procedureCode_coding | String | The coding of the procedureCode. The code for the performed procedure type. |
procedureCode_text | String | The text of the procedureCode. The code for the performed procedure type. |
location_display | String | The display of the location. The principal physical location where the ImagingStudy was performed. |
location_reference | String | The reference of the location. The principal physical location where the ImagingStudy was performed. |
location_identifier_value | String | The value of the location-identifier. The principal physical location where the ImagingStudy was performed. |
location_type | String | The location-type of the location-type. The principal physical location where the ImagingStudy was performed. |
reasonCode_coding | String | The coding of the reasonCode. Description of clinical condition indicating why the ImagingStudy was requested. |
reasonCode_text | String | The text of the reasonCode. Description of clinical condition indicating why the ImagingStudy was requested. |
reasonReference_display | String | The display of the reasonReference. Indicates another resource whose existence justifies this Study. |
reasonReference_reference | String | The reference of the reasonReference. Indicates another resource whose existence justifies this Study. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Indicates another resource whose existence justifies this Study. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Indicates another resource whose existence justifies this Study. |
note | String | Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element. |
description | String | The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed. |
series_id | String | The series-id of the series-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
series_extension | String | The series-extension of the series-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
series_modifierExtension | String | The series-modifierExtension of the series-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
series_uid | String | The series-uid of the series-uid. The DICOM Series Instance UID for the series. |
series_number | String | The series-number of the series-number. The numeric identifier of this series in the study. |
series_modality_version | String | The version of the series-modality. The modality of this series sequence. |
series_modality_code | String | The code of the series-modality. The modality of this series sequence. |
series_modality_display | String | The display of the series-modality. The modality of this series sequence. |
series_modality_userSelected | Bool | The userSelected of the series-modality. The modality of this series sequence. |
series_modality_system | String | The series-modality-system of the series-modality-system. The modality of this series sequence. |
series_description | String | The series-description of the series-description. A description of the series. |
series_numberOfInstances | String | The series-numberOfInstances of the series-numberOfInstances. Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present. |
series_endpoint_display | String | The display of the series-endpoint. The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType. |
series_endpoint_reference | String | The reference of the series-endpoint. The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType. |
series_endpoint_identifier_value | String | The value of the series-endpoint-identifier. The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType. |
series_endpoint_type | String | The series-endpoint-type of the series-endpoint-type. The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType. |
series_bodySite_version | String | The version of the series-bodySite. The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality. |
series_bodySite_code | String | The code of the series-bodySite. The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality. |
series_bodySite_display | String | The display of the series-bodySite. The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality. |
series_bodySite_userSelected | Bool | The userSelected of the series-bodySite. The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality. |
series_bodySite_system | String | The series-bodySite-system of the series-bodySite-system. The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality. |
series_laterality_version | String | The version of the series-laterality. The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite. |
series_laterality_code | String | The code of the series-laterality. The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite. |
series_laterality_display | String | The display of the series-laterality. The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite. |
series_laterality_userSelected | Bool | The userSelected of the series-laterality. The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite. |
series_laterality_system | String | The series-laterality-system of the series-laterality-system. The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite. |
series_specimen_display | String | The display of the series-specimen. The specimen imaged, e.g., for whole slide imaging of a biopsy. |
series_specimen_reference | String | The reference of the series-specimen. The specimen imaged, e.g., for whole slide imaging of a biopsy. |
series_specimen_identifier_value | String | The value of the series-specimen-identifier. The specimen imaged, e.g., for whole slide imaging of a biopsy. |
series_specimen_type | String | The series-specimen-type of the series-specimen-type. The specimen imaged, e.g., for whole slide imaging of a biopsy. |
series_started | Datetime | The series-started of the series-started. The date and time the series was started. |
series_performer_id | String | The series-performer-id of the series-performer-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
series_performer_extension | String | The series-performer-extension of the series-performer-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
series_performer_modifierExtension | String | The series-performer-modifierExtension of the series-performer-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
series_performer_function_coding | String | The coding of the series-performer-function. Distinguishes the type of involvement of the performer in the series. |
series_performer_function_text | String | The text of the series-performer-function. Distinguishes the type of involvement of the performer in the series. |
series_performer_actor_display | String | The display of the series-performer-actor. Indicates who or what performed the series. |
series_performer_actor_reference | String | The reference of the series-performer-actor. Indicates who or what performed the series. |
series_performer_actor_identifier_value | String | The value of the series-performer-actor-identifier. Indicates who or what performed the series. |
series_performer_actor_type | String | The series-performer-actor-type of the series-performer-actor-type. Indicates who or what performed the series. |
series_instance_id | String | The series-instance-id of the series-instance-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
series_instance_extension | String | The series-instance-extension of the series-instance-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
series_instance_modifierExtension | String | The series-instance-modifierExtension of the series-instance-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
series_instance_uid | String | The series-instance-uid of the series-instance-uid. The DICOM SOP Instance UID for this image or other DICOM content. |
series_instance_sopClass_version | String | The version of the series-instance-sopClass. DICOM instance type. |
series_instance_sopClass_code | String | The code of the series-instance-sopClass. DICOM instance type. |
series_instance_sopClass_display | String | The display of the series-instance-sopClass. DICOM instance type. |
series_instance_sopClass_userSelected | Bool | The userSelected of the series-instance-sopClass. DICOM instance type. |
series_instance_sopClass_system | String | The series-instance-sopClass-system of the series-instance-sopClass-system. DICOM instance type. |
series_instance_number | String | The series-instance-number of the series-instance-number. The number of instance in the series. |
series_instance_title | String | The series-instance-title of the series-instance-title. The description of the instance. |
SP_source | String | The SP_source search parameter. |
SP_instance_end | String | The SP_instance_end search parameter. |
SP_performer | String | The SP_performer search parameter. |
SP_reason_start | String | The SP_reason_start search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_referrer | String | The SP_referrer search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_endpoint | String | The SP_endpoint search parameter. |
SP_dicom_class_start | String | The SP_dicom_class_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_interpreter | String | The SP_interpreter search parameter. |
SP_basedon | String | The SP_basedon search parameter. |
SP_bodysite_end | String | The SP_bodysite_end search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_modality_start | String | The SP_modality_start search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_modality_end | String | The SP_modality_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_reason_end | String | The SP_reason_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_series_start | String | The SP_series_start search parameter. |
SP_dicom_class_end | String | The SP_dicom_class_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_instance_start | String | The SP_instance_start search parameter. |
SP_series_end | String | The SP_series_end search parameter. |
SP_bodysite_start | String | The SP_bodysite_start search parameter. |
Immunization view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique identifier assigned to this immunization record. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this immunization record. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this immunization record. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this immunization record. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this immunization record. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this immunization record. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this immunization record. |
status | String | Indicates the current status of the immunization event. |
statusReason_coding | String | The coding of the statusReason. Indicates the reason the immunization event was not performed. |
statusReason_text | String | The text of the statusReason. Indicates the reason the immunization event was not performed. |
vaccineCode_coding | String | The coding of the vaccineCode. Vaccine that was administered or was to be administered. |
vaccineCode_text | String | The text of the vaccineCode. Vaccine that was administered or was to be administered. |
patient_display | String | The display of the patient. The patient who either received or did not receive the immunization. |
patient_reference | String | The reference of the patient. The patient who either received or did not receive the immunization. |
patient_identifier_value | String | The value of the patient-identifier. The patient who either received or did not receive the immunization. |
patient_type | String | The patient-type of the patient-type. The patient who either received or did not receive the immunization. |
encounter_display | String | The display of the encounter. The visit or admission or other contact between patient and health care provider the immunization was performed as part of. |
encounter_reference | String | The reference of the encounter. The visit or admission or other contact between patient and health care provider the immunization was performed as part of. |
encounter_identifier_value | String | The value of the encounter-identifier. The visit or admission or other contact between patient and health care provider the immunization was performed as part of. |
encounter_type | String | The encounter-type of the encounter-type. The visit or admission or other contact between patient and health care provider the immunization was performed as part of. |
occurrence_x_ | Datetime | Date vaccine administered or was to be administered. |
recorded | Datetime | The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event. |
primarySource | Bool | An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded. |
reportOrigin_coding | String | The coding of the reportOrigin. The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine. |
reportOrigin_text | String | The text of the reportOrigin. The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine. |
location_display | String | The display of the location. The service delivery location where the vaccine administration occurred. |
location_reference | String | The reference of the location. The service delivery location where the vaccine administration occurred. |
location_identifier_value | String | The value of the location-identifier. The service delivery location where the vaccine administration occurred. |
location_type | String | The location-type of the location-type. The service delivery location where the vaccine administration occurred. |
manufacturer_display | String | The display of the manufacturer. Name of vaccine manufacturer. |
manufacturer_reference | String | The reference of the manufacturer. Name of vaccine manufacturer. |
manufacturer_identifier_value | String | The value of the manufacturer-identifier. Name of vaccine manufacturer. |
manufacturer_type | String | The manufacturer-type of the manufacturer-type. Name of vaccine manufacturer. |
lotNumber | String | Lot number of the vaccine product. |
expirationDate | Date | Date vaccine batch expires. |
site_coding | String | The coding of the site. Body site where vaccine was administered. |
site_text | String | The text of the site. Body site where vaccine was administered. |
route_coding | String | The coding of the route. The path by which the vaccine product is taken into the body. |
route_text | String | The text of the route. The path by which the vaccine product is taken into the body. |
doseQuantity_value | Decimal | The value of the doseQuantity. The quantity of vaccine product that was administered. |
doseQuantity_unit | String | The unit of the doseQuantity. The quantity of vaccine product that was administered. |
doseQuantity_system | String | The system of the doseQuantity. The quantity of vaccine product that was administered. |
doseQuantity_comparator | String | The doseQuantity-comparator of the doseQuantity-comparator. The quantity of vaccine product that was administered. |
doseQuantity_code | String | The doseQuantity-code of the doseQuantity-code. The quantity of vaccine product that was administered. |
performer_id | String | The performer-id of the performer-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
performer_extension | String | The performer-extension of the performer-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
performer_modifierExtension | String | The performer-modifierExtension of the performer-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
performer_function_coding | String | The coding of the performer-function. Describes the type of performance (e.g. ordering provider, administering provider, etc.). |
performer_function_text | String | The text of the performer-function. Describes the type of performance (e.g. ordering provider, administering provider, etc.). |
performer_actor_display | String | The display of the performer-actor. The practitioner or organization who performed the action. |
performer_actor_reference | String | The reference of the performer-actor. The practitioner or organization who performed the action. |
performer_actor_identifier_value | String | The value of the performer-actor-identifier. The practitioner or organization who performed the action. |
performer_actor_type | String | The performer-actor-type of the performer-actor-type. The practitioner or organization who performed the action. |
note | String | Extra information about the immunization that is not conveyed by the other attributes. |
reasonCode_coding | String | The coding of the reasonCode. Reasons why the vaccine was administered. |
reasonCode_text | String | The text of the reasonCode. Reasons why the vaccine was administered. |
reasonReference_display | String | The display of the reasonReference. Condition, Observation or DiagnosticReport that supports why the immunization was administered. |
reasonReference_reference | String | The reference of the reasonReference. Condition, Observation or DiagnosticReport that supports why the immunization was administered. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Condition, Observation or DiagnosticReport that supports why the immunization was administered. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Condition, Observation or DiagnosticReport that supports why the immunization was administered. |
isSubpotent | Bool | Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. |
subpotentReason_coding | String | The coding of the subpotentReason. Reason why a dose is considered to be subpotent. |
subpotentReason_text | String | The text of the subpotentReason. Reason why a dose is considered to be subpotent. |
education_id | String | The education-id of the education-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
education_extension | String | The education-extension of the education-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
education_modifierExtension | String | The education-modifierExtension of the education-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
education_documentType | String | The education-documentType of the education-documentType. Identifier of the material presented to the patient. |
education_reference | String | The education-reference of the education-reference. Reference pointer to the educational material given to the patient if the information was on line. |
education_publicationDate | Datetime | The education-publicationDate of the education-publicationDate. Date the educational material was published. |
education_presentationDate | Datetime | The education-presentationDate of the education-presentationDate. Date the educational material was given to the patient. |
programEligibility_coding | String | The coding of the programEligibility. Indicates a patient's eligibility for a funding program. |
programEligibility_text | String | The text of the programEligibility. Indicates a patient's eligibility for a funding program. |
fundingSource_coding | String | The coding of the fundingSource. Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered). |
fundingSource_text | String | The text of the fundingSource. Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered). |
reaction_id | String | The reaction-id of the reaction-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
reaction_extension | String | The reaction-extension of the reaction-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
reaction_modifierExtension | String | The reaction-modifierExtension of the reaction-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
reaction_date | Datetime | The reaction-date of the reaction-date. Date of reaction to the immunization. |
reaction_detail_display | String | The display of the reaction-detail. Details of the reaction. |
reaction_detail_reference | String | The reference of the reaction-detail. Details of the reaction. |
reaction_detail_identifier_value | String | The value of the reaction-detail-identifier. Details of the reaction. |
reaction_detail_type | String | The reaction-detail-type of the reaction-detail-type. Details of the reaction. |
reaction_reported | Bool | The reaction-reported of the reaction-reported. Self-reported indicator. |
protocolApplied_id | String | The protocolApplied-id of the protocolApplied-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
protocolApplied_extension | String | The protocolApplied-extension of the protocolApplied-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
protocolApplied_modifierExtension | String | The protocolApplied-modifierExtension of the protocolApplied-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
protocolApplied_series | String | The protocolApplied-series of the protocolApplied-series. One possible path to achieve presumed immunity against a disease - within the context of an authority. |
protocolApplied_authority_display | String | The display of the protocolApplied-authority. Indicates the authority who published the protocol (e.g. ACIP) that is being followed. |
protocolApplied_authority_reference | String | The reference of the protocolApplied-authority. Indicates the authority who published the protocol (e.g. ACIP) that is being followed. |
protocolApplied_authority_identifier_value | String | The value of the protocolApplied-authority-identifier. Indicates the authority who published the protocol (e.g. ACIP) that is being followed. |
protocolApplied_authority_type | String | The protocolApplied-authority-type of the protocolApplied-authority-type. Indicates the authority who published the protocol (e.g. ACIP) that is being followed. |
protocolApplied_targetDisease_coding | String | The coding of the protocolApplied-targetDisease. The vaccine preventable disease the dose is being administered against. |
protocolApplied_targetDisease_text | String | The text of the protocolApplied-targetDisease. The vaccine preventable disease the dose is being administered against. |
protocolApplied_doseNumber_x_ | Int | The protocolApplied-doseNumber[x] of the protocolApplied-doseNumber[x]. Nominal position in a series. |
protocolApplied_seriesDoses_x_ | Int | The protocolApplied-seriesDoses[x] of the protocolApplied-seriesDoses[x]. The recommended number of doses to achieve immunity. |
SP_location | String | The SP_location search parameter. |
SP_source | String | The SP_source search parameter. |
SP_status_reason_start | String | The SP_status_reason_start search parameter. |
SP_performer | String | The SP_performer search parameter. |
SP_status_reason_end | String | The SP_status_reason_end search parameter. |
SP_text | String | The SP_text search parameter. |
SP_reaction | String | The SP_reaction search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_target_disease_end | String | The SP_target_disease_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_reason_reference | String | The SP_reason_reference search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_series | String | The SP_series search parameter. |
SP_list | String | The SP_list search parameter. |
SP_reason_code_start | String | The SP_reason_code_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_target_disease_start | String | The SP_target_disease_start search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_lot_number | String | The SP_lot_number search parameter. |
SP_vaccine_code_start | String | The SP_vaccine_code_start search parameter. |
SP_vaccine_code_end | String | The SP_vaccine_code_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_reason_code_end | String | The SP_reason_code_end search parameter. |
SP_date | String | The SP_date search parameter. |
SP_manufacturer | String | The SP_manufacturer search parameter. |
ImmunizationEvaluation view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique identifier assigned to this immunization evaluation record. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this immunization evaluation record. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this immunization evaluation record. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this immunization evaluation record. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this immunization evaluation record. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this immunization evaluation record. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this immunization evaluation record. |
status | String | Indicates the current status of the evaluation of the vaccination administration event. |
patient_display | String | The display of the patient. The individual for whom the evaluation is being done. |
patient_reference | String | The reference of the patient. The individual for whom the evaluation is being done. |
patient_identifier_value | String | The value of the patient-identifier. The individual for whom the evaluation is being done. |
patient_type | String | The patient-type of the patient-type. The individual for whom the evaluation is being done. |
date | Datetime | The date the evaluation of the vaccine administration event was performed. |
authority_display | String | The display of the authority. Indicates the authority who published the protocol (e.g. ACIP). |
authority_reference | String | The reference of the authority. Indicates the authority who published the protocol (e.g. ACIP). |
authority_identifier_value | String | The value of the authority-identifier. Indicates the authority who published the protocol (e.g. ACIP). |
authority_type | String | The authority-type of the authority-type. Indicates the authority who published the protocol (e.g. ACIP). |
targetDisease_coding | String | The coding of the targetDisease. The vaccine preventable disease the dose is being evaluated against. |
targetDisease_text | String | The text of the targetDisease. The vaccine preventable disease the dose is being evaluated against. |
immunizationEvent_display | String | The display of the immunizationEvent. The vaccine administration event being evaluated. |
immunizationEvent_reference | String | The reference of the immunizationEvent. The vaccine administration event being evaluated. |
immunizationEvent_identifier_value | String | The value of the immunizationEvent-identifier. The vaccine administration event being evaluated. |
immunizationEvent_type | String | The immunizationEvent-type of the immunizationEvent-type. The vaccine administration event being evaluated. |
doseStatus_coding | String | The coding of the doseStatus. Indicates if the dose is valid or not valid with respect to the published recommendations. |
doseStatus_text | String | The text of the doseStatus. Indicates if the dose is valid or not valid with respect to the published recommendations. |
doseStatusReason_coding | String | The coding of the doseStatusReason. Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations. |
doseStatusReason_text | String | The text of the doseStatusReason. Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations. |
description | String | Additional information about the evaluation. |
series | String | One possible path to achieve presumed immunity against a disease - within the context of an authority. |
doseNumber_x_ | Int | Nominal position in a series. |
seriesDoses_x_ | Int | The recommended number of doses to achieve immunity. |
SP_dose_status_end | String | The SP_dose_status_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_target_disease_end | String | The SP_target_disease_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_target_disease_start | String | The SP_target_disease_start search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_dose_status_start | String | The SP_dose_status_start search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_immunization_event | String | The SP_immunization_event search parameter. |
ImmunizationRecommendation view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique identifier assigned to this particular recommendation record. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this particular recommendation record. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this particular recommendation record. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this particular recommendation record. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this particular recommendation record. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this particular recommendation record. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this particular recommendation record. |
patient_display | String | The display of the patient. The patient the recommendation(s) are for. |
patient_reference | String | The reference of the patient. The patient the recommendation(s) are for. |
patient_identifier_value | String | The value of the patient-identifier. The patient the recommendation(s) are for. |
patient_type | String | The patient-type of the patient-type. The patient the recommendation(s) are for. |
date | Datetime | The date the immunization recommendation(s) were created. |
authority_display | String | The display of the authority. Indicates the authority who published the protocol (e.g. ACIP). |
authority_reference | String | The reference of the authority. Indicates the authority who published the protocol (e.g. ACIP). |
authority_identifier_value | String | The value of the authority-identifier. Indicates the authority who published the protocol (e.g. ACIP). |
authority_type | String | The authority-type of the authority-type. Indicates the authority who published the protocol (e.g. ACIP). |
recommendation_id | String | The recommendation-id of the recommendation-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
recommendation_extension | String | The recommendation-extension of the recommendation-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
recommendation_modifierExtension | String | The recommendation-modifierExtension of the recommendation-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
recommendation_vaccineCode_coding | String | The coding of the recommendation-vaccineCode. Vaccine(s) or vaccine group that pertain to the recommendation. |
recommendation_vaccineCode_text | String | The text of the recommendation-vaccineCode. Vaccine(s) or vaccine group that pertain to the recommendation. |
recommendation_targetDisease_coding | String | The coding of the recommendation-targetDisease. The targeted disease for the recommendation. |
recommendation_targetDisease_text | String | The text of the recommendation-targetDisease. The targeted disease for the recommendation. |
recommendation_contraindicatedVaccineCode_coding | String | The coding of the recommendation-contraindicatedVaccineCode. Vaccine(s) which should not be used to fulfill the recommendation. |
recommendation_contraindicatedVaccineCode_text | String | The text of the recommendation-contraindicatedVaccineCode. Vaccine(s) which should not be used to fulfill the recommendation. |
recommendation_forecastStatus_coding | String | The coding of the recommendation-forecastStatus. Indicates the patient status with respect to the path to immunity for the target disease. |
recommendation_forecastStatus_text | String | The text of the recommendation-forecastStatus. Indicates the patient status with respect to the path to immunity for the target disease. |
recommendation_forecastReason_coding | String | The coding of the recommendation-forecastReason. The reason for the assigned forecast status. |
recommendation_forecastReason_text | String | The text of the recommendation-forecastReason. The reason for the assigned forecast status. |
recommendation_dateCriterion_id | String | The recommendation-dateCriterion-id of the recommendation-dateCriterion-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
recommendation_dateCriterion_extension | String | The recommendation-dateCriterion-extension of the recommendation-dateCriterion-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
recommendation_dateCriterion_modifierExtension | String | The recommendation-dateCriterion-modifierExtension of the recommendation-dateCriterion-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
recommendation_dateCriterion_code_coding | String | The coding of the recommendation-dateCriterion-code. Date classification of recommendation. For example, earliest date to give, latest date to give, etc. |
recommendation_dateCriterion_code_text | String | The text of the recommendation-dateCriterion-code. Date classification of recommendation. For example, earliest date to give, latest date to give, etc. |
recommendation_dateCriterion_value | Datetime | The recommendation-dateCriterion-value of the recommendation-dateCriterion-value. The date whose meaning is specified by dateCriterion.code. |
recommendation_description | String | The recommendation-description of the recommendation-description. Contains the description about the protocol under which the vaccine was administered. |
recommendation_series | String | The recommendation-series of the recommendation-series. One possible path to achieve presumed immunity against a disease - within the context of an authority. |
recommendation_doseNumber_x_ | Int | The recommendation-doseNumber[x] of the recommendation-doseNumber[x]. Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose). |
recommendation_seriesDoses_x_ | Int | The recommendation-seriesDoses[x] of the recommendation-seriesDoses[x]. The recommended number of doses to achieve immunity. |
recommendation_supportingImmunization_display | String | The display of the recommendation-supportingImmunization. Immunization event history and/or evaluation that supports the status and recommendation. |
recommendation_supportingImmunization_reference | String | The reference of the recommendation-supportingImmunization. Immunization event history and/or evaluation that supports the status and recommendation. |
recommendation_supportingImmunization_identifier_value | String | The value of the recommendation-supportingImmunization-identifier. Immunization event history and/or evaluation that supports the status and recommendation. |
recommendation_supportingImmunization_type | String | The recommendation-supportingImmunization-type of the recommendation-supportingImmunization-type. Immunization event history and/or evaluation that supports the status and recommendation. |
recommendation_supportingPatientInformation_display | String | The display of the recommendation-supportingPatientInformation. Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information. |
recommendation_supportingPatientInformation_reference | String | The reference of the recommendation-supportingPatientInformation. Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information. |
recommendation_supportingPatientInformation_identifier_value | String | The value of the recommendation-supportingPatientInformation-identifier. Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information. |
recommendation_supportingPatientInformation_type | String | The recommendation-supportingPatientInformation-type of the recommendation-supportingPatientInformation-type. Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_vaccine_type_end | String | The SP_vaccine_type_end search parameter. |
SP_content | String | The SP_content search parameter. |
SP_status_start | String | The SP_status_start search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_target_disease_end | String | The SP_target_disease_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_status_end | String | The SP_status_end search parameter. |
SP_support | String | The SP_support search parameter. |
SP_list | String | The SP_list search parameter. |
SP_vaccine_type_start | String | The SP_vaccine_type_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_target_disease_start | String | The SP_target_disease_start search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_information | String | The SP_information search parameter. |
Ingredient view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
identifier_use | String | The identifier-use of the identifier-use. The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
identifier_type_coding | String | The coding of the identifier-type. The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
identifier_type_text | String | The text of the identifier-type. The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
identifier_system | String | The identifier-system of the identifier-system. The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
identifier_period_start | Datetime | The start of the identifier-period. The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
identifier_period_end | Datetime | The end of the identifier-period. The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
status | String | The status of this ingredient. Enables tracking the life-cycle of the content. |
for_display | String | The display of the for. The product which this ingredient is a constituent part of. |
for_reference | String | The reference of the for. The product which this ingredient is a constituent part of. |
for_identifier_value | String | The value of the for-identifier. The product which this ingredient is a constituent part of. |
for_type | String | The for-type of the for-type. The product which this ingredient is a constituent part of. |
role_coding | String | The coding of the role. A classification of the ingredient identifying its purpose within the product, e.g. active, inactive. |
role_text | String | The text of the role. A classification of the ingredient identifying its purpose within the product, e.g. active, inactive. |
function_coding | String | The coding of the function. A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent. |
function_text | String | The text of the function. A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent. |
allergenicIndicator | Bool | If the ingredient is a known or suspected allergen. |
manufacturer_id | String | The manufacturer-id of the manufacturer-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
manufacturer_extension | String | The manufacturer-extension of the manufacturer-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
manufacturer_modifierExtension | String | The manufacturer-modifierExtension of the manufacturer-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
manufacturer_role_version | String | The version of the manufacturer-role. The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role. |
manufacturer_role_code | String | The code of the manufacturer-role. The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role. |
manufacturer_role_display | String | The display of the manufacturer-role. The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role. |
manufacturer_role_userSelected | Bool | The userSelected of the manufacturer-role. The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role. |
manufacturer_role_system | String | The manufacturer-role-system of the manufacturer-role-system. The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role. |
manufacturer_manufacturer_display | String | The display of the manufacturer-manufacturer. An organization that manufactures this ingredient. |
manufacturer_manufacturer_reference | String | The reference of the manufacturer-manufacturer. An organization that manufactures this ingredient. |
manufacturer_manufacturer_identifier_value | String | The value of the manufacturer-manufacturer-identifier. An organization that manufactures this ingredient. |
manufacturer_manufacturer_type | String | The manufacturer-manufacturer-type of the manufacturer-manufacturer-type. An organization that manufactures this ingredient. |
substance_id | String | The substance-id of the substance-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
substance_extension | String | The substance-extension of the substance-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
substance_modifierExtension | String | The substance-modifierExtension of the substance-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
substance_code_display | String | The display of the substance-code. A code or full resource that represents the ingredient substance. |
substance_code_reference | String | The reference of the substance-code. A code or full resource that represents the ingredient substance. |
substance_code_identifier_value | String | The value of the substance-code-identifier. A code or full resource that represents the ingredient substance. |
substance_code_type | String | The substance-code-type of the substance-code-type. A code or full resource that represents the ingredient substance. |
substance_strength_id | String | The substance-strength-id of the substance-strength-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
substance_strength_extension | String | The substance-strength-extension of the substance-strength-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
substance_strength_modifierExtension | String | The substance-strength-modifierExtension of the substance-strength-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
substance_strength_presentation_x_ | String | The substance-strength-presentation[x] of the substance-strength-presentation[x]. The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. |
substance_strength_presentationText | String | The substance-strength-presentationText of the substance-strength-presentationText. A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio. |
substance_strength_concentration_x_ | String | The substance-strength-concentration[x] of the substance-strength-concentration[x]. The strength per unitary volume (or mass). |
substance_strength_concentrationText | String | The substance-strength-concentrationText of the substance-strength-concentrationText. A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio. |
substance_strength_measurementPoint | String | The substance-strength-measurementPoint of the substance-strength-measurementPoint. For when strength is measured at a particular point or distance. |
substance_strength_country_coding | String | The coding of the substance-strength-country. The country or countries for which the strength range applies. |
substance_strength_country_text | String | The text of the substance-strength-country. The country or countries for which the strength range applies. |
substance_strength_referenceStrength_id | String | The substance-strength-referenceStrength-id of the substance-strength-referenceStrength-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
substance_strength_referenceStrength_extension | String | The substance-strength-referenceStrength-extension of the substance-strength-referenceStrength-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
substance_strength_referenceStrength_modifierExtension | String | The substance-strength-referenceStrength-modifierExtension of the substance-strength-referenceStrength-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
substance_strength_referenceStrength_substance_display | String | The display of the substance-strength-referenceStrength-substance. Relevant reference substance. |
substance_strength_referenceStrength_substance_reference | String | The reference of the substance-strength-referenceStrength-substance. Relevant reference substance. |
substance_strength_referenceStrength_substance_identifier_value | String | The value of the substance-strength-referenceStrength-substance-identifier. Relevant reference substance. |
substance_strength_referenceStrength_substance_type | String | The substance-strength-referenceStrength-substance-type of the substance-strength-referenceStrength-substance-type. Relevant reference substance. |
substance_strength_referenceStrength_strength_x_ | String | The substance-strength-referenceStrength-strength[x] of the substance-strength-referenceStrength-strength[x]. Strength expressed in terms of a reference substance. |
substance_strength_referenceStrength_measurementPoint | String | The substance-strength-referenceStrength-measurementPoint of the substance-strength-referenceStrength-measurementPoint. For when strength is measured at a particular point or distance. |
substance_strength_referenceStrength_country_coding | String | The coding of the substance-strength-referenceStrength-country. The country or countries for which the strength range applies. |
substance_strength_referenceStrength_country_text | String | The text of the substance-strength-referenceStrength-country. The country or countries for which the strength range applies. |
SP_function_end | String | The SP_function_end search parameter. |
SP_function_start | String | The SP_function_start search parameter. |
SP_source | String | The SP_source search parameter. |
SP_substance_definition | String | The SP_substance_definition search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_role_start | String | The SP_role_start search parameter. |
SP_substance_code_end | String | The SP_substance_code_end search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_substance | String | The SP_substance search parameter. |
SP_list | String | The SP_list search parameter. |
SP_substance_code_start | String | The SP_substance_code_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_role_end | String | The SP_role_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_for | String | The SP_for search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_manufacturer | String | The SP_manufacturer search parameter. |
InsurancePlan view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server. |
status | String | The current state of the health insurance product. |
type_coding | String | The coding of the type. The kind of health insurance product. |
type_text | String | The text of the type. The kind of health insurance product. |
name | String | Official name of the health insurance product as designated by the owner. |
alias | String | A list of alternate names that the product is known as, or was known as in the past. |
period_start | Datetime | The start of the period. The period of time that the health insurance product is available. |
period_end | Datetime | The end of the period. The period of time that the health insurance product is available. |
ownedBy_display | String | The display of the ownedBy. The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'. |
ownedBy_reference | String | The reference of the ownedBy. The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'. |
ownedBy_identifier_value | String | The value of the ownedBy-identifier. The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'. |
ownedBy_type | String | The ownedBy-type of the ownedBy-type. The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'. |
administeredBy_display | String | The display of the administeredBy. An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner. |
administeredBy_reference | String | The reference of the administeredBy. An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner. |
administeredBy_identifier_value | String | The value of the administeredBy-identifier. An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner. |
administeredBy_type | String | The administeredBy-type of the administeredBy-type. An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner. |
coverageArea_display | String | The display of the coverageArea. The geographic region in which a health insurance product's benefits apply. |
coverageArea_reference | String | The reference of the coverageArea. The geographic region in which a health insurance product's benefits apply. |
coverageArea_identifier_value | String | The value of the coverageArea-identifier. The geographic region in which a health insurance product's benefits apply. |
coverageArea_type | String | The coverageArea-type of the coverageArea-type. The geographic region in which a health insurance product's benefits apply. |
contact_id | String | The contact-id of the contact-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
contact_extension | String | The contact-extension of the contact-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
contact_modifierExtension | String | The contact-modifierExtension of the contact-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
contact_purpose_coding | String | The coding of the contact-purpose. Indicates a purpose for which the contact can be reached. |
contact_purpose_text | String | The text of the contact-purpose. Indicates a purpose for which the contact can be reached. |
contact_name_use | String | The use of the contact-name. A name associated with the contact. |
contact_name_family | String | The family of the contact-name. A name associated with the contact. |
contact_name_given | String | The given of the contact-name. A name associated with the contact. |
contact_name_prefix | String | The prefix of the contact-name. A name associated with the contact. |
contact_name_suffix | String | The suffix of the contact-name. A name associated with the contact. |
contact_name_period_start | Datetime | The start of the contact-name-period. A name associated with the contact. |
contact_name_period_end | Datetime | The end of the contact-name-period. A name associated with the contact. |
contact_telecom_value | String | The value of the contact-telecom. A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
contact_telecom_system | String | The contact-telecom-system of the contact-telecom-system. A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
contact_telecom_use | String | The contact-telecom-use of the contact-telecom-use. A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
contact_telecom_rank | String | The contact-telecom-rank of the contact-telecom-rank. A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
contact_telecom_period_start | String | The start of the contact-telecom-period. A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
contact_telecom_period_end | String | The end of the contact-telecom-period. A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
contact_address_text | String | The text of the contact-address. Visiting or postal addresses for the contact. |
contact_address_line | String | The line of the contact-address. Visiting or postal addresses for the contact. |
contact_address_city | String | The city of the contact-address. Visiting or postal addresses for the contact. |
contact_address_district | String | The district of the contact-address. Visiting or postal addresses for the contact. |
contact_address_state | String | The state of the contact-address. Visiting or postal addresses for the contact. |
contact_address_postalCode | String | The postalCode of the contact-address. Visiting or postal addresses for the contact. |
contact_address_country | String | The country of the contact-address. Visiting or postal addresses for the contact. |
contact_address_type | String | The contact-address-type of the contact-address-type. Visiting or postal addresses for the contact. |
contact_address_period_start | Datetime | The start of the contact-address-period. Visiting or postal addresses for the contact. |
contact_address_period_end | Datetime | The end of the contact-address-period. Visiting or postal addresses for the contact. |
contact_address_use | String | The contact-address-use of the contact-address-use. Visiting or postal addresses for the contact. |
endpoint_display | String | The display of the endpoint. The technical endpoints providing access to services operated for the health insurance product. |
endpoint_reference | String | The reference of the endpoint. The technical endpoints providing access to services operated for the health insurance product. |
endpoint_identifier_value | String | The value of the endpoint-identifier. The technical endpoints providing access to services operated for the health insurance product. |
endpoint_type | String | The endpoint-type of the endpoint-type. The technical endpoints providing access to services operated for the health insurance product. |
network_display | String | The display of the network. Reference to the network included in the health insurance product. |
network_reference | String | The reference of the network. Reference to the network included in the health insurance product. |
network_identifier_value | String | The value of the network-identifier. Reference to the network included in the health insurance product. |
network_type | String | The network-type of the network-type. Reference to the network included in the health insurance product. |
coverage_id | String | The coverage-id of the coverage-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
coverage_extension | String | The coverage-extension of the coverage-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
coverage_modifierExtension | String | The coverage-modifierExtension of the coverage-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
coverage_type_coding | String | The coding of the coverage-type. Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health). |
coverage_type_text | String | The text of the coverage-type. Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health). |
coverage_network_display | String | The display of the coverage-network. Reference to the network that providing the type of coverage. |
coverage_network_reference | String | The reference of the coverage-network. Reference to the network that providing the type of coverage. |
coverage_network_identifier_value | String | The value of the coverage-network-identifier. Reference to the network that providing the type of coverage. |
coverage_network_type | String | The coverage-network-type of the coverage-network-type. Reference to the network that providing the type of coverage. |
coverage_benefit_id | String | The coverage-benefit-id of the coverage-benefit-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
coverage_benefit_extension | String | The coverage-benefit-extension of the coverage-benefit-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
coverage_benefit_modifierExtension | String | The coverage-benefit-modifierExtension of the coverage-benefit-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
coverage_benefit_type_coding | String | The coding of the coverage-benefit-type. Type of benefit (primary care; speciality care; inpatient; outpatient). |
coverage_benefit_type_text | String | The text of the coverage-benefit-type. Type of benefit (primary care; speciality care; inpatient; outpatient). |
coverage_benefit_requirement | String | The coverage-benefit-requirement of the coverage-benefit-requirement. The referral requirements to have access/coverage for this benefit. |
coverage_benefit_limit_id | String | The coverage-benefit-limit-id of the coverage-benefit-limit-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
coverage_benefit_limit_extension | String | The coverage-benefit-limit-extension of the coverage-benefit-limit-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
coverage_benefit_limit_modifierExtension | String | The coverage-benefit-limit-modifierExtension of the coverage-benefit-limit-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
coverage_benefit_limit_value_value | Decimal | The value of the coverage-benefit-limit-value. The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses. |
coverage_benefit_limit_value_unit | String | The unit of the coverage-benefit-limit-value. The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses. |
coverage_benefit_limit_value_system | String | The system of the coverage-benefit-limit-value. The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses. |
coverage_benefit_limit_value_comparator | String | The coverage-benefit-limit-value-comparator of the coverage-benefit-limit-value-comparator. The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses. |
coverage_benefit_limit_value_code | String | The coverage-benefit-limit-value-code of the coverage-benefit-limit-value-code. The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses. |
coverage_benefit_limit_code_coding | String | The coding of the coverage-benefit-limit-code. The specific limit on the benefit. |
coverage_benefit_limit_code_text | String | The text of the coverage-benefit-limit-code. The specific limit on the benefit. |
plan_id | String | The plan-id of the plan-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
plan_extension | String | The plan-extension of the plan-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
plan_modifierExtension | String | The plan-modifierExtension of the plan-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
plan_identifier_value | String | The value of the plan-identifier. Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server. |
plan_identifier_use | String | The plan-identifier-use of the plan-identifier-use. Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server. |
plan_identifier_type_coding | String | The coding of the plan-identifier-type. Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server. |
plan_identifier_type_text | String | The text of the plan-identifier-type. Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server. |
plan_identifier_system | String | The plan-identifier-system of the plan-identifier-system. Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server. |
plan_identifier_period_start | String | The start of the plan-identifier-period. Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server. |
plan_identifier_period_end | String | The end of the plan-identifier-period. Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server. |
plan_type_coding | String | The coding of the plan-type. Type of plan. For example, 'Platinum' or 'High Deductable'. |
plan_type_text | String | The text of the plan-type. Type of plan. For example, 'Platinum' or 'High Deductable'. |
plan_coverageArea_display | String | The display of the plan-coverageArea. The geographic region in which a health insurance plan's benefits apply. |
plan_coverageArea_reference | String | The reference of the plan-coverageArea. The geographic region in which a health insurance plan's benefits apply. |
plan_coverageArea_identifier_value | String | The value of the plan-coverageArea-identifier. The geographic region in which a health insurance plan's benefits apply. |
plan_coverageArea_type | String | The plan-coverageArea-type of the plan-coverageArea-type. The geographic region in which a health insurance plan's benefits apply. |
plan_network_display | String | The display of the plan-network. Reference to the network that providing the type of coverage. |
plan_network_reference | String | The reference of the plan-network. Reference to the network that providing the type of coverage. |
plan_network_identifier_value | String | The value of the plan-network-identifier. Reference to the network that providing the type of coverage. |
plan_network_type | String | The plan-network-type of the plan-network-type. Reference to the network that providing the type of coverage. |
plan_generalCost_id | String | The plan-generalCost-id of the plan-generalCost-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
plan_generalCost_extension | String | The plan-generalCost-extension of the plan-generalCost-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
plan_generalCost_modifierExtension | String | The plan-generalCost-modifierExtension of the plan-generalCost-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
plan_generalCost_type_coding | String | The coding of the plan-generalCost-type. Type of cost. |
plan_generalCost_type_text | String | The text of the plan-generalCost-type. Type of cost. |
plan_generalCost_groupSize | Int | The plan-generalCost-groupSize of the plan-generalCost-groupSize. Number of participants enrolled in the plan. |
plan_generalCost_cost | String | The plan-generalCost-cost of the plan-generalCost-cost. Value of the cost. |
plan_generalCost_comment | String | The plan-generalCost-comment of the plan-generalCost-comment. Additional information about the general costs associated with this plan. |
plan_specificCost_id | String | The plan-specificCost-id of the plan-specificCost-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
plan_specificCost_extension | String | The plan-specificCost-extension of the plan-specificCost-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
plan_specificCost_modifierExtension | String | The plan-specificCost-modifierExtension of the plan-specificCost-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
plan_specificCost_category_coding | String | The coding of the plan-specificCost-category. General category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health). |
plan_specificCost_category_text | String | The text of the plan-specificCost-category. General category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health). |
plan_specificCost_benefit_id | String | The plan-specificCost-benefit-id of the plan-specificCost-benefit-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
plan_specificCost_benefit_extension | String | The plan-specificCost-benefit-extension of the plan-specificCost-benefit-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
plan_specificCost_benefit_modifierExtension | String | The plan-specificCost-benefit-modifierExtension of the plan-specificCost-benefit-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
plan_specificCost_benefit_type_coding | String | The coding of the plan-specificCost-benefit-type. Type of specific benefit (preventative; primary care office visit; speciality office visit; hospitalization; emergency room; urgent care). |
plan_specificCost_benefit_type_text | String | The text of the plan-specificCost-benefit-type. Type of specific benefit (preventative; primary care office visit; speciality office visit; hospitalization; emergency room; urgent care). |
plan_specificCost_benefit_cost_id | String | The plan-specificCost-benefit-cost-id of the plan-specificCost-benefit-cost-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
plan_specificCost_benefit_cost_extension | String | The plan-specificCost-benefit-cost-extension of the plan-specificCost-benefit-cost-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
plan_specificCost_benefit_cost_modifierExtension | String | The plan-specificCost-benefit-cost-modifierExtension of the plan-specificCost-benefit-cost-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
plan_specificCost_benefit_cost_type_coding | String | The coding of the plan-specificCost-benefit-cost-type. Type of cost (copay; individual cap; family cap; coinsurance; deductible). |
plan_specificCost_benefit_cost_type_text | String | The text of the plan-specificCost-benefit-cost-type. Type of cost (copay; individual cap; family cap; coinsurance; deductible). |
plan_specificCost_benefit_cost_applicability_coding | String | The coding of the plan-specificCost-benefit-cost-applicability. Whether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other). |
plan_specificCost_benefit_cost_applicability_text | String | The text of the plan-specificCost-benefit-cost-applicability. Whether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other). |
plan_specificCost_benefit_cost_qualifiers_coding | String | The coding of the plan-specificCost-benefit-cost-qualifiers. Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA). |
plan_specificCost_benefit_cost_qualifiers_text | String | The text of the plan-specificCost-benefit-cost-qualifiers. Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA). |
plan_specificCost_benefit_cost_value_value | Decimal | The value of the plan-specificCost-benefit-cost-value. The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance). |
plan_specificCost_benefit_cost_value_unit | String | The unit of the plan-specificCost-benefit-cost-value. The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance). |
plan_specificCost_benefit_cost_value_system | String | The system of the plan-specificCost-benefit-cost-value. The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance). |
plan_specificCost_benefit_cost_value_comparator | String | The plan-specificCost-benefit-cost-value-comparator of the plan-specificCost-benefit-cost-value-comparator. The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance). |
plan_specificCost_benefit_cost_value_code | String | The plan-specificCost-benefit-cost-value-code of the plan-specificCost-benefit-cost-value-code. The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance). |
SP_source | String | The SP_source search parameter. |
SP_address_postalcode | String | The SP_address_postalcode search parameter. |
SP_text | String | The SP_text search parameter. |
SP_owned_by | String | The SP_owned_by search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_address | String | The SP_address search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_endpoint | String | The SP_endpoint search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_phonetic | String | The SP_phonetic search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_address_use_end | String | The SP_address_use_end search parameter. |
SP_address_country | String | The SP_address_country search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_address_city | String | The SP_address_city search parameter. |
SP_address_state | String | The SP_address_state search parameter. |
SP_address_use_start | String | The SP_address_use_start search parameter. |
SP_administered_by | String | The SP_administered_by search parameter. |
Invoice view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. |
identifier_use | String | The identifier-use of the identifier-use. Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. |
identifier_type_coding | String | The coding of the identifier-type. Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. |
identifier_type_text | String | The text of the identifier-type. Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. |
identifier_system | String | The identifier-system of the identifier-system. Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. |
identifier_period_start | String | The start of the identifier-period. Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. |
identifier_period_end | String | The end of the identifier-period. Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. |
status | String | The current state of the Invoice. |
cancelledReason | String | In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.). |
type_coding | String | The coding of the type. Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary). |
type_text | String | The text of the type. Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary). |
subject_display | String | The display of the subject. The individual or set of individuals receiving the goods and services billed in this invoice. |
subject_reference | String | The reference of the subject. The individual or set of individuals receiving the goods and services billed in this invoice. |
subject_identifier_value | String | The value of the subject-identifier. The individual or set of individuals receiving the goods and services billed in this invoice. |
subject_type | String | The subject-type of the subject-type. The individual or set of individuals receiving the goods and services billed in this invoice. |
recipient_display | String | The display of the recipient. The individual or Organization responsible for balancing of this invoice. |
recipient_reference | String | The reference of the recipient. The individual or Organization responsible for balancing of this invoice. |
recipient_identifier_value | String | The value of the recipient-identifier. The individual or Organization responsible for balancing of this invoice. |
recipient_type | String | The recipient-type of the recipient-type. The individual or Organization responsible for balancing of this invoice. |
date | Datetime | Date/time(s) of when this Invoice was posted. |
participant_id | String | The participant-id of the participant-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
participant_extension | String | The participant-extension of the participant-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
participant_modifierExtension | String | The participant-modifierExtension of the participant-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
participant_role_coding | String | The coding of the participant-role. Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device. |
participant_role_text | String | The text of the participant-role. Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device. |
participant_actor_display | String | The display of the participant-actor. The device, practitioner, etc. who performed or participated in the service. |
participant_actor_reference | String | The reference of the participant-actor. The device, practitioner, etc. who performed or participated in the service. |
participant_actor_identifier_value | String | The value of the participant-actor-identifier. The device, practitioner, etc. who performed or participated in the service. |
participant_actor_type | String | The participant-actor-type of the participant-actor-type. The device, practitioner, etc. who performed or participated in the service. |
issuer_display | String | The display of the issuer. The organizationissuing the Invoice. |
issuer_reference | String | The reference of the issuer. The organizationissuing the Invoice. |
issuer_identifier_value | String | The value of the issuer-identifier. The organizationissuing the Invoice. |
issuer_type | String | The issuer-type of the issuer-type. The organizationissuing the Invoice. |
account_display | String | The display of the account. Account which is supposed to be balanced with this Invoice. |
account_reference | String | The reference of the account. Account which is supposed to be balanced with this Invoice. |
account_identifier_value | String | The value of the account-identifier. Account which is supposed to be balanced with this Invoice. |
account_type | String | The account-type of the account-type. Account which is supposed to be balanced with this Invoice. |
lineItem_id | String | The lineItem-id of the lineItem-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
lineItem_extension | String | The lineItem-extension of the lineItem-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
lineItem_modifierExtension | String | The lineItem-modifierExtension of the lineItem-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
lineItem_sequence | Int | The lineItem-sequence of the lineItem-sequence. Sequence in which the items appear on the invoice. |
lineItem_chargeItem_x_display | String | The display of the lineItem-chargeItem[x]. The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference. |
lineItem_chargeItem_x_reference | String | The reference of the lineItem-chargeItem[x]. The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference. |
lineItem_chargeItem_x_identifier_value | String | The value of the lineItem-chargeItem[x]-identifier. The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference. |
lineItem_chargeItem_x_type | String | The lineItem-chargeItem[x]-type of the lineItem-chargeItem[x]-type. The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference. |
lineItem_priceComponent_id | String | The lineItem-priceComponent-id of the lineItem-priceComponent-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
lineItem_priceComponent_extension | String | The lineItem-priceComponent-extension of the lineItem-priceComponent-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
lineItem_priceComponent_modifierExtension | String | The lineItem-priceComponent-modifierExtension of the lineItem-priceComponent-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
lineItem_priceComponent_type | String | The lineItem-priceComponent-type of the lineItem-priceComponent-type. This code identifies the type of the component. |
lineItem_priceComponent_code_coding | String | The coding of the lineItem-priceComponent-code. A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. |
lineItem_priceComponent_code_text | String | The text of the lineItem-priceComponent-code. A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. |
lineItem_priceComponent_factor | Decimal | The lineItem-priceComponent-factor of the lineItem-priceComponent-factor. The factor that has been applied on the base price for calculating this component. |
lineItem_priceComponent_amount | String | The lineItem-priceComponent-amount of the lineItem-priceComponent-amount. The amount calculated for this component. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_account | String | The SP_account search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_recipient | String | The SP_recipient search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_participant_role_end | String | The SP_participant_role_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_participant_role_start | String | The SP_participant_role_start search parameter. |
SP_issuer | String | The SP_issuer search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_totalnet | String | The SP_totalnet search parameter. |
SP_participant | String | The SP_participant search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_totalgross | String | The SP_totalgross search parameter. |
Library view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers. |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. |
identifier_period_start | String | The start of the identifier-period. A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. |
identifier_period_end | String | The end of the identifier-period. A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. |
version | String | The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. |
name | String | A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
title | String | A short, descriptive, user-friendly title for the library. |
subtitle | String | An explanatory or alternate title for the library giving additional information about its content. |
status | String | The status of this library. Enables tracking the life-cycle of the content. |
experimental | Bool | A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
type_coding | String | The coding of the type. Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. |
type_text | String | The text of the type. Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. |
subject_x_coding | String | The coding of the subject[x]. A code or group definition that describes the intended subject of the contents of the library. |
subject_x_text | String | The text of the subject[x]. A code or group definition that describes the intended subject of the contents of the library. |
date | Datetime | The date (and optionally time) when the library was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes. |
publisher | String | The name of the organization or individual that published the library. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
description | String | A free text natural language description of the library from a consumer's perspective. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances. |
jurisdiction_coding | String | The coding of the jurisdiction. A legal or geographic region in which the library is intended to be used. |
jurisdiction_text | String | The text of the jurisdiction. A legal or geographic region in which the library is intended to be used. |
purpose | String | Explanation of why this library is needed and why it has been designed as it has. |
usage | String | A detailed description of how the library is used from a clinical perspective. |
copyright | String | A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library. |
approvalDate | Date | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
lastReviewDate | Date | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
effectivePeriod_start | Datetime | The start of the effectivePeriod. The period during which the library content was or is planned to be in active use. |
effectivePeriod_end | Datetime | The end of the effectivePeriod. The period during which the library content was or is planned to be in active use. |
topic_coding | String | The coding of the topic. Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching. |
topic_text | String | The text of the topic. Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching. |
author | String | An individiual or organization primarily involved in the creation and maintenance of the content. |
editor | String | An individual or organization primarily responsible for internal coherence of the content. |
reviewer | String | An individual or organization primarily responsible for review of some aspect of the content. |
endorser | String | An individual or organization responsible for officially endorsing the content for use in some setting. |
relatedArtifact | String | Related artifacts such as additional documentation, justification, or bibliographic references. |
parameter | String | The parameter element defines parameters used by the library. |
dataRequirement | String | Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library. |
content_data | String | The data of the content. The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. |
content_url | String | The url of the content. The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. |
content_size | String | The size of the content. The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. |
content_title | String | The title of the content. The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. |
content_creation | String | The creation of the content. The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. |
content_height | String | The height of the content. The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. |
content_width | String | The width of the content. The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. |
content_frames | String | The frames of the content. The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. |
content_duration | String | The duration of the content. The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. |
content_pages | String | The pages of the content. The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. |
content_contentType | String | The content-contentType of the content-contentType. The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. |
content_language | String | The content-language of the content-language. The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. |
SP_context_end | String | The SP_context_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_depends_on | String | The SP_depends_on search parameter. |
SP_predecessor | String | The SP_predecessor search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_jurisdiction_start | String | The SP_jurisdiction_start search parameter. |
SP_effective | String | The SP_effective search parameter. |
SP_topic_end | String | The SP_topic_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_context_type_start | String | The SP_context_type_start search parameter. |
SP_context_quantity | String | The SP_context_quantity search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_context_type_value | String | The SP_context_type_value search parameter. |
SP_successor | String | The SP_successor search parameter. |
SP_context_type_quantity | String | The SP_context_type_quantity search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_derived_from | String | The SP_derived_from search parameter. |
SP_context_type_end | String | The SP_context_type_end search parameter. |
SP_content_type_start | String | The SP_content_type_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_context_start | String | The SP_context_start search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_composed_of | String | The SP_composed_of search parameter. |
SP_jurisdiction_end | String | The SP_jurisdiction_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_content_type_end | String | The SP_content_type_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_topic_start | String | The SP_topic_start search parameter. |
List view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifier for the List assigned for business purposes outside the context of FHIR. |
identifier_use | String | The identifier-use of the identifier-use. Identifier for the List assigned for business purposes outside the context of FHIR. |
identifier_type_coding | String | The coding of the identifier-type. Identifier for the List assigned for business purposes outside the context of FHIR. |
identifier_type_text | String | The text of the identifier-type. Identifier for the List assigned for business purposes outside the context of FHIR. |
identifier_system | String | The identifier-system of the identifier-system. Identifier for the List assigned for business purposes outside the context of FHIR. |
identifier_period_start | String | The start of the identifier-period. Identifier for the List assigned for business purposes outside the context of FHIR. |
identifier_period_end | String | The end of the identifier-period. Identifier for the List assigned for business purposes outside the context of FHIR. |
status | String | Indicates the current state of this list. |
mode | String | How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
title | String | A label for the list assigned by the author. |
code_coding | String | The coding of the code. This code defines the purpose of the list - why it was created. |
code_text | String | The text of the code. This code defines the purpose of the list - why it was created. |
subject_display | String | The display of the subject. The common subject (or patient) of the resources that are in the list if there is one. |
subject_reference | String | The reference of the subject. The common subject (or patient) of the resources that are in the list if there is one. |
subject_identifier_value | String | The value of the subject-identifier. The common subject (or patient) of the resources that are in the list if there is one. |
subject_type | String | The subject-type of the subject-type. The common subject (or patient) of the resources that are in the list if there is one. |
encounter_display | String | The display of the encounter. The encounter that is the context in which this list was created. |
encounter_reference | String | The reference of the encounter. The encounter that is the context in which this list was created. |
encounter_identifier_value | String | The value of the encounter-identifier. The encounter that is the context in which this list was created. |
encounter_type | String | The encounter-type of the encounter-type. The encounter that is the context in which this list was created. |
date | Datetime | The date that the list was prepared. |
source_display | String | The display of the source. The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. |
source_reference | String | The reference of the source. The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. |
source_identifier_value | String | The value of the source-identifier. The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. |
source_type | String | The source-type of the source-type. The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. |
orderedBy_coding | String | The coding of the orderedBy. What order applies to the items in the list. |
orderedBy_text | String | The text of the orderedBy. What order applies to the items in the list. |
note | String | Comments that apply to the overall list. |
entry_id | String | The entry-id of the entry-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
entry_extension | String | The entry-extension of the entry-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
entry_modifierExtension | String | The entry-modifierExtension of the entry-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
entry_flag_coding | String | The coding of the entry-flag. The flag allows the system constructing the list to indicate the role and significance of the item in the list. |
entry_flag_text | String | The text of the entry-flag. The flag allows the system constructing the list to indicate the role and significance of the item in the list. |
entry_deleted | Bool | The entry-deleted of the entry-deleted. True if this item is marked as deleted in the list. |
entry_date | Datetime | The entry-date of the entry-date. When this item was added to the list. |
entry_item_display | String | The display of the entry-item. A reference to the actual resource from which data was derived. |
entry_item_reference | String | The reference of the entry-item. A reference to the actual resource from which data was derived. |
entry_item_identifier_value | String | The value of the entry-item-identifier. A reference to the actual resource from which data was derived. |
entry_item_type | String | The entry-item-type of the entry-item-type. A reference to the actual resource from which data was derived. |
emptyReason_coding | String | The coding of the emptyReason. If the list is empty, why the list is empty. |
emptyReason_text | String | The text of the emptyReason. If the list is empty, why the list is empty. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_empty_reason_end | String | The SP_empty_reason_end search parameter. |
SP_notes | String | The SP_notes search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_empty_reason_start | String | The SP_empty_reason_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_item | String | The SP_item search parameter. |
Location view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Unique code or number identifying the location to its users. |
identifier_use | String | The identifier-use of the identifier-use. Unique code or number identifying the location to its users. |
identifier_type_coding | String | The coding of the identifier-type. Unique code or number identifying the location to its users. |
identifier_type_text | String | The text of the identifier-type. Unique code or number identifying the location to its users. |
identifier_system | String | The identifier-system of the identifier-system. Unique code or number identifying the location to its users. |
identifier_period_start | String | The start of the identifier-period. Unique code or number identifying the location to its users. |
identifier_period_end | String | The end of the identifier-period. Unique code or number identifying the location to its users. |
status | String | The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location. |
operationalStatus_version | String | The version of the operationalStatus. The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. |
operationalStatus_code | String | The code of the operationalStatus. The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. |
operationalStatus_display | String | The display of the operationalStatus. The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. |
operationalStatus_userSelected | Bool | The userSelected of the operationalStatus. The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. |
operationalStatus_system | String | The operationalStatus-system of the operationalStatus-system. The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. |
name | String | Name of the location as used by humans. Does not need to be unique. |
alias | String | A list of alternate names that the location is known as, or was known as, in the past. |
description | String | Description of the Location, which helps in finding or referencing the place. |
mode | String | Indicates whether a resource instance represents a specific location or a class of locations. |
type_coding | String | The coding of the type. Indicates the type of function performed at the location. |
type_text | String | The text of the type. Indicates the type of function performed at the location. |
telecom_value | String | The value of the telecom. The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
telecom_system | String | The telecom-system of the telecom-system. The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
telecom_use | String | The telecom-use of the telecom-use. The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
telecom_rank | String | The telecom-rank of the telecom-rank. The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
telecom_period_start | String | The start of the telecom-period. The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
telecom_period_end | String | The end of the telecom-period. The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
address_text | String | The text of the address. Physical location. |
address_line | String | The line of the address. Physical location. |
address_city | String | The city of the address. Physical location. |
address_district | String | The district of the address. Physical location. |
address_state | String | The state of the address. Physical location. |
address_postalCode | String | The postalCode of the address. Physical location. |
address_country | String | The country of the address. Physical location. |
address_type | String | The address-type of the address-type. Physical location. |
address_period_start | Datetime | The start of the address-period. Physical location. |
address_period_end | Datetime | The end of the address-period. Physical location. |
address_use | String | The address-use of the address-use. Physical location. |
physicalType_coding | String | The coding of the physicalType. Physical form of the location, e.g. building, room, vehicle, road. |
physicalType_text | String | The text of the physicalType. Physical form of the location, e.g. building, room, vehicle, road. |
position_id | String | The position-id of the position-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
position_extension | String | The position-extension of the position-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
position_modifierExtension | String | The position-modifierExtension of the position-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
position_longitude | Decimal | The position-longitude of the position-longitude. Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). |
position_latitude | Decimal | The position-latitude of the position-latitude. Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). |
position_altitude | Decimal | The position-altitude of the position-altitude. Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). |
managingOrganization_display | String | The display of the managingOrganization. The organization responsible for the provisioning and upkeep of the location. |
managingOrganization_reference | String | The reference of the managingOrganization. The organization responsible for the provisioning and upkeep of the location. |
managingOrganization_identifier_value | String | The value of the managingOrganization-identifier. The organization responsible for the provisioning and upkeep of the location. |
managingOrganization_type | String | The managingOrganization-type of the managingOrganization-type. The organization responsible for the provisioning and upkeep of the location. |
partOf_display | String | The display of the partOf. Another Location of which this Location is physically a part of. |
partOf_reference | String | The reference of the partOf. Another Location of which this Location is physically a part of. |
partOf_identifier_value | String | The value of the partOf-identifier. Another Location of which this Location is physically a part of. |
partOf_type | String | The partOf-type of the partOf-type. Another Location of which this Location is physically a part of. |
hoursOfOperation_id | String | The hoursOfOperation-id of the hoursOfOperation-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
hoursOfOperation_extension | String | The hoursOfOperation-extension of the hoursOfOperation-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
hoursOfOperation_modifierExtension | String | The hoursOfOperation-modifierExtension of the hoursOfOperation-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
hoursOfOperation_daysOfWeek | String | The hoursOfOperation-daysOfWeek of the hoursOfOperation-daysOfWeek. Indicates which days of the week are available between the start and end Times. |
hoursOfOperation_allDay | Bool | The hoursOfOperation-allDay of the hoursOfOperation-allDay. The Location is open all day. |
hoursOfOperation_openingTime | Time | The hoursOfOperation-openingTime of the hoursOfOperation-openingTime. Time that the Location opens. |
hoursOfOperation_closingTime | Time | The hoursOfOperation-closingTime of the hoursOfOperation-closingTime. Time that the Location closes. |
availabilityExceptions | String | A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times. |
endpoint_display | String | The display of the endpoint. Technical endpoints providing access to services operated for the location. |
endpoint_reference | String | The reference of the endpoint. Technical endpoints providing access to services operated for the location. |
endpoint_identifier_value | String | The value of the endpoint-identifier. Technical endpoints providing access to services operated for the location. |
endpoint_type | String | The endpoint-type of the endpoint-type. Technical endpoints providing access to services operated for the location. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_address | String | The SP_address search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_endpoint | String | The SP_endpoint search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_partof | String | The SP_partof search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_operational_status_start | String | The SP_operational_status_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_operational_status_end | String | The SP_operational_status_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_near | String | The SP_near search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_organization | String | The SP_organization search parameter. |
Measure view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers. |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_start | String | The start of the identifier-period. A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_end | String | The end of the identifier-period. A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance. |
version | String | The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. |
name | String | A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
title | String | A short, descriptive, user-friendly title for the measure. |
subtitle | String | An explanatory or alternate title for the measure giving additional information about its content. |
status | String | The status of this measure. Enables tracking the life-cycle of the content. |
experimental | Bool | A Boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
subject_x_coding | String | The coding of the subject[x]. The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything. |
subject_x_text | String | The text of the subject[x]. The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything. |
date | Datetime | The date (and optionally time) when the measure was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes. |
publisher | String | The name of the organization or individual that published the measure. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
description | String | A free text natural language description of the measure from a consumer's perspective. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate measure instances. |
jurisdiction_coding | String | The coding of the jurisdiction. A legal or geographic region in which the measure is intended to be used. |
jurisdiction_text | String | The text of the jurisdiction. A legal or geographic region in which the measure is intended to be used. |
purpose | String | Explanation of why this measure is needed and why it has been designed as it has. |
usage | String | A detailed description, from a clinical perspective, of how the measure is used. |
copyright | String | A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure. |
approvalDate | Date | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
lastReviewDate | Date | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
effectivePeriod_start | Datetime | The start of the effectivePeriod. The period during which the measure content was or is planned to be in active use. |
effectivePeriod_end | Datetime | The end of the effectivePeriod. The period during which the measure content was or is planned to be in active use. |
topic_coding | String | The coding of the topic. Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching. |
topic_text | String | The text of the topic. Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching. |
author | String | An individiual or organization primarily involved in the creation and maintenance of the content. |
editor | String | An individual or organization primarily responsible for internal coherence of the content. |
reviewer | String | An individual or organization primarily responsible for review of some aspect of the content. |
endorser | String | An individual or organization responsible for officially endorsing the content for use in some setting. |
relatedArtifact | String | Related artifacts such as additional documentation, justification, or bibliographic references. |
library | String | A reference to a Library resource containing the formal logic used by the measure. |
disclaimer | String | Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure. |
scoring_coding | String | The coding of the scoring. Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. |
scoring_text | String | The text of the scoring. Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. |
compositeScoring_coding | String | The coding of the compositeScoring. If this is a composite measure, the scoring method used to combine the component measures to determine the composite score. |
compositeScoring_text | String | The text of the compositeScoring. If this is a composite measure, the scoring method used to combine the component measures to determine the composite score. |
type_coding | String | The coding of the type. Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization. |
type_text | String | The text of the type. Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization. |
riskAdjustment | String | A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results. |
rateAggregation | String | Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result. |
rationale | String | Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence. |
clinicalRecommendationStatement | String | Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure. |
improvementNotation_coding | String | The coding of the improvementNotation. Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range). |
improvementNotation_text | String | The text of the improvementNotation. Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range). |
definition | String | Provides a description of an individual term used within the measure. |
guidance | String | Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure. |
group_id | String | The group-id of the group-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
group_extension | String | The group-extension of the group-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
group_modifierExtension | String | The group-modifierExtension of the group-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
group_code_coding | String | The coding of the group-code. Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures. |
group_code_text | String | The text of the group-code. Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures. |
group_description | String | The group-description of the group-description. The human readable description of this population group. |
group_population_id | String | The group-population-id of the group-population-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
group_population_extension | String | The group-population-extension of the group-population-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
group_population_modifierExtension | String | The group-population-modifierExtension of the group-population-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
group_population_code_coding | String | The coding of the group-population-code. The type of population criteria. |
group_population_code_text | String | The text of the group-population-code. The type of population criteria. |
group_population_description | String | The group-population-description of the group-population-description. The human readable description of this population criteria. |
group_population_criteria | String | The group-population-criteria of the group-population-criteria. An expression that specifies the criteria for the population, typically the name of an expression in a library. |
group_stratifier_id | String | The group-stratifier-id of the group-stratifier-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
group_stratifier_extension | String | The group-stratifier-extension of the group-stratifier-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
group_stratifier_modifierExtension | String | The group-stratifier-modifierExtension of the group-stratifier-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
group_stratifier_code_coding | String | The coding of the group-stratifier-code. Indicates a meaning for the stratifier. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures. |
group_stratifier_code_text | String | The text of the group-stratifier-code. Indicates a meaning for the stratifier. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures. |
group_stratifier_description | String | The group-stratifier-description of the group-stratifier-description. The human readable description of this stratifier criteria. |
group_stratifier_criteria | String | The group-stratifier-criteria of the group-stratifier-criteria. An expression that specifies the criteria for the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element. |
group_stratifier_component_id | String | The group-stratifier-component-id of the group-stratifier-component-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
group_stratifier_component_extension | String | The group-stratifier-component-extension of the group-stratifier-component-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
group_stratifier_component_modifierExtension | String | The group-stratifier-component-modifierExtension of the group-stratifier-component-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
group_stratifier_component_code_coding | String | The coding of the group-stratifier-component-code. Indicates a meaning for the stratifier component. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures. |
group_stratifier_component_code_text | String | The text of the group-stratifier-component-code. Indicates a meaning for the stratifier component. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures. |
group_stratifier_component_description | String | The group-stratifier-component-description of the group-stratifier-component-description. The human readable description of this stratifier criteria component. |
group_stratifier_component_criteria | String | The group-stratifier-component-criteria of the group-stratifier-component-criteria. An expression that specifies the criteria for this component of the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element. |
supplementalData_id | String | The supplementalData-id of the supplementalData-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
supplementalData_extension | String | The supplementalData-extension of the supplementalData-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
supplementalData_modifierExtension | String | The supplementalData-modifierExtension of the supplementalData-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
supplementalData_code_coding | String | The coding of the supplementalData-code. Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures. |
supplementalData_code_text | String | The text of the supplementalData-code. Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures. |
supplementalData_usage_coding | String | The coding of the supplementalData-usage. An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation. |
supplementalData_usage_text | String | The text of the supplementalData-usage. An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation. |
supplementalData_description | String | The supplementalData-description of the supplementalData-description. The human readable description of this supplemental data. |
supplementalData_criteria | String | The supplementalData-criteria of the supplementalData-criteria. The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element. |
SP_context_end | String | The SP_context_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_depends_on | String | The SP_depends_on search parameter. |
SP_predecessor | String | The SP_predecessor search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_jurisdiction_start | String | The SP_jurisdiction_start search parameter. |
SP_effective | String | The SP_effective search parameter. |
SP_topic_end | String | The SP_topic_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_context_type_start | String | The SP_context_type_start search parameter. |
SP_context_quantity | String | The SP_context_quantity search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_context_type_value | String | The SP_context_type_value search parameter. |
SP_successor | String | The SP_successor search parameter. |
SP_context_type_quantity | String | The SP_context_type_quantity search parameter. |
SP_derived_from | String | The SP_derived_from search parameter. |
SP_context_type_end | String | The SP_context_type_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_context_start | String | The SP_context_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_composed_of | String | The SP_composed_of search parameter. |
SP_jurisdiction_end | String | The SP_jurisdiction_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_topic_start | String | The SP_topic_start search parameter. |
MeasureReport view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance. |
identifier_period_start | String | The start of the identifier-period. A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance. |
identifier_period_end | String | The end of the identifier-period. A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance. |
status | String | The MeasureReport status. No data will be available until the MeasureReport status is complete. |
type | String | The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure. |
measure | String | A reference to the Measure that was calculated to produce this report. |
subject_display | String | The display of the subject. Optional subject identifying the individual or individuals the report is for. |
subject_reference | String | The reference of the subject. Optional subject identifying the individual or individuals the report is for. |
subject_identifier_value | String | The value of the subject-identifier. Optional subject identifying the individual or individuals the report is for. |
subject_type | String | The subject-type of the subject-type. Optional subject identifying the individual or individuals the report is for. |
date | Datetime | The date this measure report was generated. |
reporter_display | String | The display of the reporter. The individual, location, or organization that is reporting the data. |
reporter_reference | String | The reference of the reporter. The individual, location, or organization that is reporting the data. |
reporter_identifier_value | String | The value of the reporter-identifier. The individual, location, or organization that is reporting the data. |
reporter_type | String | The reporter-type of the reporter-type. The individual, location, or organization that is reporting the data. |
period_start | Datetime | The start of the period. The reporting period for which the report was calculated. |
period_end | Datetime | The end of the period. The reporting period for which the report was calculated. |
improvementNotation_coding | String | The coding of the improvementNotation. Whether improvement in the measure is noted by an increase or decrease in the measure score. |
improvementNotation_text | String | The text of the improvementNotation. Whether improvement in the measure is noted by an increase or decrease in the measure score. |
group_id | String | The group-id of the group-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
group_extension | String | The group-extension of the group-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
group_modifierExtension | String | The group-modifierExtension of the group-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
group_code_coding | String | The coding of the group-code. The meaning of the population group as defined in the measure definition. |
group_code_text | String | The text of the group-code. The meaning of the population group as defined in the measure definition. |
group_population_id | String | The group-population-id of the group-population-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
group_population_extension | String | The group-population-extension of the group-population-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
group_population_modifierExtension | String | The group-population-modifierExtension of the group-population-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
group_population_code_coding | String | The coding of the group-population-code. The type of the population. |
group_population_code_text | String | The text of the group-population-code. The type of the population. |
group_population_count | Int | The group-population-count of the group-population-count. The number of members of the population. |
group_population_subjectResults_display | String | The display of the group-population-subjectResults. This element refers to a List of subject level MeasureReport resources, one for each subject in this population. |
group_population_subjectResults_reference | String | The reference of the group-population-subjectResults. This element refers to a List of subject level MeasureReport resources, one for each subject in this population. |
group_population_subjectResults_identifier_value | String | The value of the group-population-subjectResults-identifier. This element refers to a List of subject level MeasureReport resources, one for each subject in this population. |
group_population_subjectResults_type | String | The group-population-subjectResults-type of the group-population-subjectResults-type. This element refers to a List of subject level MeasureReport resources, one for each subject in this population. |
group_measureScore_value | Decimal | The value of the group-measureScore. The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group. |
group_measureScore_unit | String | The unit of the group-measureScore. The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group. |
group_measureScore_system | String | The system of the group-measureScore. The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group. |
group_measureScore_comparator | String | The group-measureScore-comparator of the group-measureScore-comparator. The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group. |
group_measureScore_code | String | The group-measureScore-code of the group-measureScore-code. The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group. |
group_stratifier_id | String | The group-stratifier-id of the group-stratifier-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
group_stratifier_extension | String | The group-stratifier-extension of the group-stratifier-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
group_stratifier_modifierExtension | String | The group-stratifier-modifierExtension of the group-stratifier-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
group_stratifier_code_coding | String | The coding of the group-stratifier-code. The meaning of this stratifier, as defined in the measure definition. |
group_stratifier_code_text | String | The text of the group-stratifier-code. The meaning of this stratifier, as defined in the measure definition. |
group_stratifier_stratum_id | String | The group-stratifier-stratum-id of the group-stratifier-stratum-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
group_stratifier_stratum_extension | String | The group-stratifier-stratum-extension of the group-stratifier-stratum-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
group_stratifier_stratum_modifierExtension | String | The group-stratifier-stratum-modifierExtension of the group-stratifier-stratum-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
group_stratifier_stratum_value_coding | String | The coding of the group-stratifier-stratum-value. The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique. |
group_stratifier_stratum_value_text | String | The text of the group-stratifier-stratum-value. The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique. |
group_stratifier_stratum_component_id | String | The group-stratifier-stratum-component-id of the group-stratifier-stratum-component-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
group_stratifier_stratum_component_extension | String | The group-stratifier-stratum-component-extension of the group-stratifier-stratum-component-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
group_stratifier_stratum_component_modifierExtension | String | The group-stratifier-stratum-component-modifierExtension of the group-stratifier-stratum-component-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
group_stratifier_stratum_component_code_coding | String | The coding of the group-stratifier-stratum-component-code. The code for the stratum component value. |
group_stratifier_stratum_component_code_text | String | The text of the group-stratifier-stratum-component-code. The code for the stratum component value. |
group_stratifier_stratum_component_value_coding | String | The coding of the group-stratifier-stratum-component-value. The stratum component value. |
group_stratifier_stratum_component_value_text | String | The text of the group-stratifier-stratum-component-value. The stratum component value. |
group_stratifier_stratum_population_id | String | The group-stratifier-stratum-population-id of the group-stratifier-stratum-population-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
group_stratifier_stratum_population_extension | String | The group-stratifier-stratum-population-extension of the group-stratifier-stratum-population-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
group_stratifier_stratum_population_modifierExtension | String | The group-stratifier-stratum-population-modifierExtension of the group-stratifier-stratum-population-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
group_stratifier_stratum_population_code_coding | String | The coding of the group-stratifier-stratum-population-code. The type of the population. |
group_stratifier_stratum_population_code_text | String | The text of the group-stratifier-stratum-population-code. The type of the population. |
group_stratifier_stratum_population_count | Int | The group-stratifier-stratum-population-count of the group-stratifier-stratum-population-count. The number of members of the population in this stratum. |
group_stratifier_stratum_population_subjectResults_display | String | The display of the group-stratifier-stratum-population-subjectResults. This element refers to a List of subject level MeasureReport resources, one for each subject in this population in this stratum. |
group_stratifier_stratum_population_subjectResults_reference | String | The reference of the group-stratifier-stratum-population-subjectResults. This element refers to a List of subject level MeasureReport resources, one for each subject in this population in this stratum. |
group_stratifier_stratum_population_subjectResults_identifier_value | String | The value of the group-stratifier-stratum-population-subjectResults-identifier. This element refers to a List of subject level MeasureReport resources, one for each subject in this population in this stratum. |
group_stratifier_stratum_population_subjectResults_type | String | The group-stratifier-stratum-population-subjectResults-type of the group-stratifier-stratum-population-subjectResults-type. This element refers to a List of subject level MeasureReport resources, one for each subject in this population in this stratum. |
group_stratifier_stratum_measureScore_value | Decimal | The value of the group-stratifier-stratum-measureScore. The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum. |
group_stratifier_stratum_measureScore_unit | String | The unit of the group-stratifier-stratum-measureScore. The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum. |
group_stratifier_stratum_measureScore_system | String | The system of the group-stratifier-stratum-measureScore. The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum. |
group_stratifier_stratum_measureScore_comparator | String | The group-stratifier-stratum-measureScore-comparator of the group-stratifier-stratum-measureScore-comparator. The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum. |
group_stratifier_stratum_measureScore_code | String | The group-stratifier-stratum-measureScore-code of the group-stratifier-stratum-measureScore-code. The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum. |
evaluatedResource_display | String | The display of the evaluatedResource. A reference to a Bundle containing the Resources that were used in the calculation of this measure. |
evaluatedResource_reference | String | The reference of the evaluatedResource. A reference to a Bundle containing the Resources that were used in the calculation of this measure. |
evaluatedResource_identifier_value | String | The value of the evaluatedResource-identifier. A reference to a Bundle containing the Resources that were used in the calculation of this measure. |
evaluatedResource_type | String | The evaluatedResource-type of the evaluatedResource-type. A reference to a Bundle containing the Resources that were used in the calculation of this measure. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_evaluated_resource | String | The SP_evaluated_resource search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_reporter | String | The SP_reporter search parameter. |
SP_period | String | The SP_period search parameter. |
SP_filter | String | The SP_filter search parameter. |
Media view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers. |
identifier_use | String | The identifier-use of the identifier-use. Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers. |
identifier_type_coding | String | The coding of the identifier-type. Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers. |
identifier_type_text | String | The text of the identifier-type. Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers. |
identifier_system | String | The identifier-system of the identifier-system. Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers. |
identifier_period_start | String | The start of the identifier-period. Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers. |
identifier_period_end | String | The end of the identifier-period. Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers. |
basedOn_display | String | The display of the basedOn. A procedure that is fulfilled in whole or in part by the creation of this media. |
basedOn_reference | String | The reference of the basedOn. A procedure that is fulfilled in whole or in part by the creation of this media. |
basedOn_identifier_value | String | The value of the basedOn-identifier. A procedure that is fulfilled in whole or in part by the creation of this media. |
basedOn_type | String | The basedOn-type of the basedOn-type. A procedure that is fulfilled in whole or in part by the creation of this media. |
partOf_display | String | The display of the partOf. A larger event of which this particular event is a component or step. |
partOf_reference | String | The reference of the partOf. A larger event of which this particular event is a component or step. |
partOf_identifier_value | String | The value of the partOf-identifier. A larger event of which this particular event is a component or step. |
partOf_type | String | The partOf-type of the partOf-type. A larger event of which this particular event is a component or step. |
status | String | The current state of the {{title}}. |
type_coding | String | The coding of the type. A code that classifies whether the media is an image, video or audio recording or some other media category. |
type_text | String | The text of the type. A code that classifies whether the media is an image, video or audio recording or some other media category. |
modality_coding | String | The coding of the modality. Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality. |
modality_text | String | The text of the modality. Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality. |
view_coding | String | The coding of the view. The name of the imaging view e.g. Lateral or Antero-posterior (AP). |
view_text | String | The text of the view. The name of the imaging view e.g. Lateral or Antero-posterior (AP). |
subject_display | String | The display of the subject. Who/What this Media is a record of. |
subject_reference | String | The reference of the subject. Who/What this Media is a record of. |
subject_identifier_value | String | The value of the subject-identifier. Who/What this Media is a record of. |
subject_type | String | The subject-type of the subject-type. Who/What this Media is a record of. |
encounter_display | String | The display of the encounter. The encounter that establishes the context for this media. |
encounter_reference | String | The reference of the encounter. The encounter that establishes the context for this media. |
encounter_identifier_value | String | The value of the encounter-identifier. The encounter that establishes the context for this media. |
encounter_type | String | The encounter-type of the encounter-type. The encounter that establishes the context for this media. |
created_x_ | Datetime | The date and time(s) at which the media was collected. |
issued | String | The date and time this version of the media was made available to providers, typically after having been reviewed. |
operator_display | String | The display of the operator. The person who administered the collection of the image. |
operator_reference | String | The reference of the operator. The person who administered the collection of the image. |
operator_identifier_value | String | The value of the operator-identifier. The person who administered the collection of the image. |
operator_type | String | The operator-type of the operator-type. The person who administered the collection of the image. |
reasonCode_coding | String | The coding of the reasonCode. Describes why the event occurred in coded or textual form. |
reasonCode_text | String | The text of the reasonCode. Describes why the event occurred in coded or textual form. |
bodySite_coding | String | The coding of the bodySite. Indicates the site on the subject's body where the observation was made (i.e. the target site). |
bodySite_text | String | The text of the bodySite. Indicates the site on the subject's body where the observation was made (i.e. the target site). |
deviceName | String | The name of the device / manufacturer of the device that was used to make the recording. |
device_display | String | The display of the device. The device used to collect the media. |
device_reference | String | The reference of the device. The device used to collect the media. |
device_identifier_value | String | The value of the device-identifier. The device used to collect the media. |
device_type | String | The device-type of the device-type. The device used to collect the media. |
height | Int | Height of the image in pixels (photo/video). |
width | Int | Width of the image in pixels (photo/video). |
frames | Int | The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. |
duration | Decimal | The duration of the recording in seconds - for audio and video. |
content_data | String | The data of the content. The actual content of the media - inline or by direct reference to the media source file. |
content_url | String | The url of the content. The actual content of the media - inline or by direct reference to the media source file. |
content_size | Int | The size of the content. The actual content of the media - inline or by direct reference to the media source file. |
content_title | String | The title of the content. The actual content of the media - inline or by direct reference to the media source file. |
content_creation | Datetime | The creation of the content. The actual content of the media - inline or by direct reference to the media source file. |
content_height | Int | The height of the content. The actual content of the media - inline or by direct reference to the media source file. |
content_width | Int | The width of the content. The actual content of the media - inline or by direct reference to the media source file. |
content_frames | Int | The frames of the content. The actual content of the media - inline or by direct reference to the media source file. |
content_duration | Decimal | The duration of the content. The actual content of the media - inline or by direct reference to the media source file. |
content_pages | Int | The pages of the content. The actual content of the media - inline or by direct reference to the media source file. |
content_contentType | String | The content-contentType of the content-contentType. The actual content of the media - inline or by direct reference to the media source file. |
content_language | String | The content-language of the content-language. The actual content of the media - inline or by direct reference to the media source file. |
note | String | Comments made about the media by the performer, subject or other participants. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_created | String | The SP_created search parameter. |
SP_view_start | String | The SP_view_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_based_on | String | The SP_based_on search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_operator | String | The SP_operator search parameter. |
SP_modality_start | String | The SP_modality_start search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_modality_end | String | The SP_modality_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_site_end | String | The SP_site_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_device | String | The SP_device search parameter. |
SP_site_start | String | The SP_site_start search parameter. |
SP_view_end | String | The SP_view_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
Medication view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifier for this medication. |
identifier_use | String | The identifier-use of the identifier-use. Business identifier for this medication. |
identifier_type_coding | String | The coding of the identifier-type. Business identifier for this medication. |
identifier_type_text | String | The text of the identifier-type. Business identifier for this medication. |
identifier_system | String | The identifier-system of the identifier-system. Business identifier for this medication. |
identifier_period_start | String | The start of the identifier-period. Business identifier for this medication. |
identifier_period_end | String | The end of the identifier-period. Business identifier for this medication. |
code_coding | String | The coding of the code. A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. |
code_text | String | The text of the code. A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. |
status | String | A code to indicate if the medication is in active use. |
manufacturer_display | String | The display of the manufacturer. Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
manufacturer_reference | String | The reference of the manufacturer. Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
manufacturer_identifier_value | String | The value of the manufacturer-identifier. Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
manufacturer_type | String | The manufacturer-type of the manufacturer-type. Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
form_coding | String | The coding of the form. Describes the form of the item. Powder; tablets; capsule. |
form_text | String | The text of the form. Describes the form of the item. Powder; tablets; capsule. |
amount | String | Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
ingredient_id | String | The ingredient-id of the ingredient-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ingredient_extension | String | The ingredient-extension of the ingredient-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
ingredient_modifierExtension | String | The ingredient-modifierExtension of the ingredient-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
ingredient_item_x_coding | String | The coding of the ingredient-item[x]. The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
ingredient_item_x_text | String | The text of the ingredient-item[x]. The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
ingredient_isActive | Bool | The ingredient-isActive of the ingredient-isActive. Indication of whether this ingredient affects the therapeutic action of the drug. |
ingredient_strength | String | The ingredient-strength of the ingredient-strength. Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet. |
batch_id | String | The batch-id of the batch-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
batch_extension | String | The batch-extension of the batch-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
batch_modifierExtension | String | The batch-modifierExtension of the batch-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
batch_lotNumber | String | The batch-lotNumber of the batch-lotNumber. The assigned lot number of a batch of the specified product. |
batch_expirationDate | Datetime | The batch-expirationDate of the batch-expirationDate. When this specific batch of product will expire. |
SP_source | String | The SP_source search parameter. |
SP_lot_number_start | String | The SP_lot_number_start search parameter. |
SP_text | String | The SP_text search parameter. |
SP_ingredient_code_end | String | The SP_ingredient_code_end search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_ingredient_code_start | String | The SP_ingredient_code_start search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_expiration_date | String | The SP_expiration_date search parameter. |
SP_form_start | String | The SP_form_start search parameter. |
SP_form_end | String | The SP_form_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_lot_number_end | String | The SP_lot_number_end search parameter. |
SP_manufacturer | String | The SP_manufacturer search parameter. |
SP_ingredient | String | The SP_ingredient search parameter. |
MedicationAdministration view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
instantiates | String | A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event. |
partOf_display | String | The display of the partOf. A larger event of which this particular event is a component or step. |
partOf_reference | String | The reference of the partOf. A larger event of which this particular event is a component or step. |
partOf_identifier_value | String | The value of the partOf-identifier. A larger event of which this particular event is a component or step. |
partOf_type | String | The partOf-type of the partOf-type. A larger event of which this particular event is a component or step. |
status | String | Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way. |
statusReason_coding | String | The coding of the statusReason. A code indicating why the administration was not performed. |
statusReason_text | String | The text of the statusReason. A code indicating why the administration was not performed. |
category_coding | String | The coding of the category. Indicates where the medication is expected to be consumed or administered. |
category_text | String | The text of the category. Indicates where the medication is expected to be consumed or administered. |
medication_x_coding | String | The coding of the medication[x]. Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
medication_x_text | String | The text of the medication[x]. Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
subject_display | String | The display of the subject. The person or animal or group receiving the medication. |
subject_reference | String | The reference of the subject. The person or animal or group receiving the medication. |
subject_identifier_value | String | The value of the subject-identifier. The person or animal or group receiving the medication. |
subject_type | String | The subject-type of the subject-type. The person or animal or group receiving the medication. |
context_display | String | The display of the context. The visit, admission, or other contact between patient and health care provider during which the medication administration was performed. |
context_reference | String | The reference of the context. The visit, admission, or other contact between patient and health care provider during which the medication administration was performed. |
context_identifier_value | String | The value of the context-identifier. The visit, admission, or other contact between patient and health care provider during which the medication administration was performed. |
context_type | String | The context-type of the context-type. The visit, admission, or other contact between patient and health care provider during which the medication administration was performed. |
supportingInformation_display | String | The display of the supportingInformation. Additional information (for example, patient height and weight) that supports the administration of the medication. |
supportingInformation_reference | String | The reference of the supportingInformation. Additional information (for example, patient height and weight) that supports the administration of the medication. |
supportingInformation_identifier_value | String | The value of the supportingInformation-identifier. Additional information (for example, patient height and weight) that supports the administration of the medication. |
supportingInformation_type | String | The supportingInformation-type of the supportingInformation-type. Additional information (for example, patient height and weight) that supports the administration of the medication. |
effective_x_ | Datetime | A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. |
performer_id | String | The performer-id of the performer-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
performer_extension | String | The performer-extension of the performer-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
performer_modifierExtension | String | The performer-modifierExtension of the performer-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
performer_function_coding | String | The coding of the performer-function. Distinguishes the type of involvement of the performer in the medication administration. |
performer_function_text | String | The text of the performer-function. Distinguishes the type of involvement of the performer in the medication administration. |
performer_actor_display | String | The display of the performer-actor. Indicates who or what performed the medication administration. |
performer_actor_reference | String | The reference of the performer-actor. Indicates who or what performed the medication administration. |
performer_actor_identifier_value | String | The value of the performer-actor-identifier. Indicates who or what performed the medication administration. |
performer_actor_type | String | The performer-actor-type of the performer-actor-type. Indicates who or what performed the medication administration. |
reasonCode_coding | String | The coding of the reasonCode. A code indicating why the medication was given. |
reasonCode_text | String | The text of the reasonCode. A code indicating why the medication was given. |
reasonReference_display | String | The display of the reasonReference. Condition or observation that supports why the medication was administered. |
reasonReference_reference | String | The reference of the reasonReference. Condition or observation that supports why the medication was administered. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Condition or observation that supports why the medication was administered. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Condition or observation that supports why the medication was administered. |
request_display | String | The display of the request. The original request, instruction or authority to perform the administration. |
request_reference | String | The reference of the request. The original request, instruction or authority to perform the administration. |
request_identifier_value | String | The value of the request-identifier. The original request, instruction or authority to perform the administration. |
request_type | String | The request-type of the request-type. The original request, instruction or authority to perform the administration. |
device_display | String | The display of the device. The device used in administering the medication to the patient. For example, a particular infusion pump. |
device_reference | String | The reference of the device. The device used in administering the medication to the patient. For example, a particular infusion pump. |
device_identifier_value | String | The value of the device-identifier. The device used in administering the medication to the patient. For example, a particular infusion pump. |
device_type | String | The device-type of the device-type. The device used in administering the medication to the patient. For example, a particular infusion pump. |
note | String | Extra information about the medication administration that is not conveyed by the other attributes. |
dosage_id | String | The dosage-id of the dosage-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
dosage_extension | String | The dosage-extension of the dosage-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
dosage_modifierExtension | String | The dosage-modifierExtension of the dosage-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
dosage_text | String | The dosage-text of the dosage-text. Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered.. |
dosage_site_coding | String | The coding of the dosage-site. A coded specification of the anatomic site where the medication first entered the body. For example, 'left arm'. |
dosage_site_text | String | The text of the dosage-site. A coded specification of the anatomic site where the medication first entered the body. For example, 'left arm'. |
dosage_route_coding | String | The coding of the dosage-route. A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc. |
dosage_route_text | String | The text of the dosage-route. A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc. |
dosage_method_coding | String | The coding of the dosage-method. A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV. |
dosage_method_text | String | The text of the dosage-method. A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV. |
dosage_dose_value | Decimal | The value of the dosage-dose. The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection. |
dosage_dose_unit | String | The unit of the dosage-dose. The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection. |
dosage_dose_system | String | The system of the dosage-dose. The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection. |
dosage_dose_comparator | String | The dosage-dose-comparator of the dosage-dose-comparator. The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection. |
dosage_dose_code | String | The dosage-dose-code of the dosage-dose-code. The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection. |
dosage_rate_x_ | String | The dosage-rate[x] of the dosage-rate[x]. Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. |
eventHistory_display | String | The display of the eventHistory. A summary of the events of interest that have occurred, such as when the administration was verified. |
eventHistory_reference | String | The reference of the eventHistory. A summary of the events of interest that have occurred, such as when the administration was verified. |
eventHistory_identifier_value | String | The value of the eventHistory-identifier. A summary of the events of interest that have occurred, such as when the administration was verified. |
eventHistory_type | String | The eventHistory-type of the eventHistory-type. A summary of the events of interest that have occurred, such as when the administration was verified. |
SP_source | String | The SP_source search parameter. |
SP_medication | String | The SP_medication search parameter. |
SP_performer | String | The SP_performer search parameter. |
SP_context | String | The SP_context search parameter. |
SP_text | String | The SP_text search parameter. |
SP_reason_not_given_start | String | The SP_reason_not_given_start search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_request | String | The SP_request search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_effective_time | String | The SP_effective_time search parameter. |
SP_reason_given_end | String | The SP_reason_given_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_reason_given_start | String | The SP_reason_given_start search parameter. |
SP_reason_not_given_end | String | The SP_reason_not_given_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_device | String | The SP_device search parameter. |
SP_filter | String | The SP_filter search parameter. |
MedicationDispense view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
partOf_display | String | The display of the partOf. The procedure that trigger the dispense. |
partOf_reference | String | The reference of the partOf. The procedure that trigger the dispense. |
partOf_identifier_value | String | The value of the partOf-identifier. The procedure that trigger the dispense. |
partOf_type | String | The partOf-type of the partOf-type. The procedure that trigger the dispense. |
status | String | A code specifying the state of the set of dispense events. |
statusReason_x_coding | String | The coding of the statusReason[x]. Indicates the reason why a dispense was not performed. |
statusReason_x_text | String | The text of the statusReason[x]. Indicates the reason why a dispense was not performed. |
category_coding | String | The coding of the category. Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)). |
category_text | String | The text of the category. Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)). |
medication_x_coding | String | The coding of the medication[x]. Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
medication_x_text | String | The text of the medication[x]. Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
subject_display | String | The display of the subject. A link to a resource representing the person or the group to whom the medication will be given. |
subject_reference | String | The reference of the subject. A link to a resource representing the person or the group to whom the medication will be given. |
subject_identifier_value | String | The value of the subject-identifier. A link to a resource representing the person or the group to whom the medication will be given. |
subject_type | String | The subject-type of the subject-type. A link to a resource representing the person or the group to whom the medication will be given. |
context_display | String | The display of the context. The encounter or episode of care that establishes the context for this event. |
context_reference | String | The reference of the context. The encounter or episode of care that establishes the context for this event. |
context_identifier_value | String | The value of the context-identifier. The encounter or episode of care that establishes the context for this event. |
context_type | String | The context-type of the context-type. The encounter or episode of care that establishes the context for this event. |
supportingInformation_display | String | The display of the supportingInformation. Additional information that supports the medication being dispensed. |
supportingInformation_reference | String | The reference of the supportingInformation. Additional information that supports the medication being dispensed. |
supportingInformation_identifier_value | String | The value of the supportingInformation-identifier. Additional information that supports the medication being dispensed. |
supportingInformation_type | String | The supportingInformation-type of the supportingInformation-type. Additional information that supports the medication being dispensed. |
performer_id | String | The performer-id of the performer-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
performer_extension | String | The performer-extension of the performer-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
performer_modifierExtension | String | The performer-modifierExtension of the performer-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
performer_function_coding | String | The coding of the performer-function. Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker. |
performer_function_text | String | The text of the performer-function. Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker. |
performer_actor_display | String | The display of the performer-actor. The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication. |
performer_actor_reference | String | The reference of the performer-actor. The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication. |
performer_actor_identifier_value | String | The value of the performer-actor-identifier. The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication. |
performer_actor_type | String | The performer-actor-type of the performer-actor-type. The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication. |
location_display | String | The display of the location. The principal physical location where the dispense was performed. |
location_reference | String | The reference of the location. The principal physical location where the dispense was performed. |
location_identifier_value | String | The value of the location-identifier. The principal physical location where the dispense was performed. |
location_type | String | The location-type of the location-type. The principal physical location where the dispense was performed. |
authorizingPrescription_display | String | The display of the authorizingPrescription. Indicates the medication order that is being dispensed against. |
authorizingPrescription_reference | String | The reference of the authorizingPrescription. Indicates the medication order that is being dispensed against. |
authorizingPrescription_identifier_value | String | The value of the authorizingPrescription-identifier. Indicates the medication order that is being dispensed against. |
authorizingPrescription_type | String | The authorizingPrescription-type of the authorizingPrescription-type. Indicates the medication order that is being dispensed against. |
type_coding | String | The coding of the type. Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. |
type_text | String | The text of the type. Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. |
quantity_value | Decimal | The value of the quantity. The amount of medication that has been dispensed. Includes unit of measure. |
quantity_unit | String | The unit of the quantity. The amount of medication that has been dispensed. Includes unit of measure. |
quantity_system | String | The system of the quantity. The amount of medication that has been dispensed. Includes unit of measure. |
quantity_comparator | String | The quantity-comparator of the quantity-comparator. The amount of medication that has been dispensed. Includes unit of measure. |
quantity_code | String | The quantity-code of the quantity-code. The amount of medication that has been dispensed. Includes unit of measure. |
daysSupply_value | Decimal | The value of the daysSupply. The amount of medication expressed as a timing amount. |
daysSupply_unit | String | The unit of the daysSupply. The amount of medication expressed as a timing amount. |
daysSupply_system | String | The system of the daysSupply. The amount of medication expressed as a timing amount. |
daysSupply_comparator | String | The daysSupply-comparator of the daysSupply-comparator. The amount of medication expressed as a timing amount. |
daysSupply_code | String | The daysSupply-code of the daysSupply-code. The amount of medication expressed as a timing amount. |
whenPrepared | Datetime | The time when the dispensed product was packaged and reviewed. |
whenHandedOver | Datetime | The time the dispensed product was provided to the patient or their representative. |
destination_display | String | The display of the destination. Identification of the facility/location where the medication was shipped to, as part of the dispense event. |
destination_reference | String | The reference of the destination. Identification of the facility/location where the medication was shipped to, as part of the dispense event. |
destination_identifier_value | String | The value of the destination-identifier. Identification of the facility/location where the medication was shipped to, as part of the dispense event. |
destination_type | String | The destination-type of the destination-type. Identification of the facility/location where the medication was shipped to, as part of the dispense event. |
receiver_display | String | The display of the receiver. Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional. |
receiver_reference | String | The reference of the receiver. Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional. |
receiver_identifier_value | String | The value of the receiver-identifier. Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional. |
receiver_type | String | The receiver-type of the receiver-type. Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional. |
note | String | Extra information about the dispense that could not be conveyed in the other attributes. |
dosageInstruction_system | String | The system of the dosageInstruction. Indicates how the medication is to be used by the patient. |
dosageInstruction_comparator | String | The dosageInstruction-comparator of the dosageInstruction-comparator. Indicates how the medication is to be used by the patient. |
substitution_id | String | The substitution-id of the substitution-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
substitution_extension | String | The substitution-extension of the substitution-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
substitution_modifierExtension | String | The substitution-modifierExtension of the substitution-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
substitution_wasSubstituted | Bool | The substitution-wasSubstituted of the substitution-wasSubstituted. True if the dispenser dispensed a different drug or product from what was prescribed. |
substitution_type_coding | String | The coding of the substitution-type. A code signifying whether a different drug was dispensed from what was prescribed. |
substitution_type_text | String | The text of the substitution-type. A code signifying whether a different drug was dispensed from what was prescribed. |
substitution_reason_coding | String | The coding of the substitution-reason. Indicates the reason for the substitution (or lack of substitution) from what was prescribed. |
substitution_reason_text | String | The text of the substitution-reason. Indicates the reason for the substitution (or lack of substitution) from what was prescribed. |
substitution_responsibleParty_display | String | The display of the substitution-responsibleParty. The person or organization that has primary responsibility for the substitution. |
substitution_responsibleParty_reference | String | The reference of the substitution-responsibleParty. The person or organization that has primary responsibility for the substitution. |
substitution_responsibleParty_identifier_value | String | The value of the substitution-responsibleParty-identifier. The person or organization that has primary responsibility for the substitution. |
substitution_responsibleParty_type | String | The substitution-responsibleParty-type of the substitution-responsibleParty-type. The person or organization that has primary responsibility for the substitution. |
detectedIssue_display | String | The display of the detectedIssue. Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc. |
detectedIssue_reference | String | The reference of the detectedIssue. Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc. |
detectedIssue_identifier_value | String | The value of the detectedIssue-identifier. Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc. |
detectedIssue_type | String | The detectedIssue-type of the detectedIssue-type. Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc. |
eventHistory_display | String | The display of the eventHistory. A summary of the events of interest that have occurred, such as when the dispense was verified. |
eventHistory_reference | String | The reference of the eventHistory. A summary of the events of interest that have occurred, such as when the dispense was verified. |
eventHistory_identifier_value | String | The value of the eventHistory-identifier. A summary of the events of interest that have occurred, such as when the dispense was verified. |
eventHistory_type | String | The eventHistory-type of the eventHistory-type. A summary of the events of interest that have occurred, such as when the dispense was verified. |
SP_source | String | The SP_source search parameter. |
SP_medication | String | The SP_medication search parameter. |
SP_performer | String | The SP_performer search parameter. |
SP_context | String | The SP_context search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_responsibleparty | String | The SP_responsibleparty search parameter. |
SP_list | String | The SP_list search parameter. |
SP_prescription | String | The SP_prescription search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_receiver | String | The SP_receiver search parameter. |
SP_destination | String | The SP_destination search parameter. |
SP_filter | String | The SP_filter search parameter. |
MedicationKnowledge view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
code_coding | String | The coding of the code. A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. |
code_text | String | The text of the code. A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. |
status | String | A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties. |
manufacturer_display | String | The display of the manufacturer. Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
manufacturer_reference | String | The reference of the manufacturer. Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
manufacturer_identifier_value | String | The value of the manufacturer-identifier. Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
manufacturer_type | String | The manufacturer-type of the manufacturer-type. Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
doseForm_coding | String | The coding of the doseForm. Describes the form of the item. Powder; tablets; capsule. |
doseForm_text | String | The text of the doseForm. Describes the form of the item. Powder; tablets; capsule. |
amount_value | Decimal | The value of the amount. Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
amount_unit | String | The unit of the amount. Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
amount_system | String | The system of the amount. Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
amount_comparator | String | The amount-comparator of the amount-comparator. Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
amount_code | String | The amount-code of the amount-code. Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
synonym | String | Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol. |
relatedid | String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
relatedextension | String | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
relatedmodifierExtension | String | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
relatedtype_coding | String | The coding of the relatedtype. The category of the associated medication knowledge reference. |
relatedtype_text | String | The text of the relatedtype. The category of the associated medication knowledge reference. |
relatedreference_display | String | The display of the relatedreference. Associated documentation about the associated medication knowledge. |
relatedreference_reference | String | The reference of the relatedreference. Associated documentation about the associated medication knowledge. |
relatedreference_identifier_value | String | The value of the relatedreference-identifier. Associated documentation about the associated medication knowledge. |
relatedreference_type | String | The relatedreference-type of the relatedreference-type. Associated documentation about the associated medication knowledge. |
associatedMedication_display | String | The display of the associatedMedication. Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor). |
associatedMedication_reference | String | The reference of the associatedMedication. Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor). |
associatedMedication_identifier_value | String | The value of the associatedMedication-identifier. Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor). |
associatedMedication_type | String | The associatedMedication-type of the associatedMedication-type. Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor). |
productType_coding | String | The coding of the productType. Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.). |
productType_text | String | The text of the productType. Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.). |
monograph_id | String | The monograph-id of the monograph-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
monograph_extension | String | The monograph-extension of the monograph-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
monograph_modifierExtension | String | The monograph-modifierExtension of the monograph-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
monograph_type_coding | String | The coding of the monograph-type. The category of documentation about the medication. (e.g. professional monograph, patient education monograph). |
monograph_type_text | String | The text of the monograph-type. The category of documentation about the medication. (e.g. professional monograph, patient education monograph). |
monograph_source_display | String | The display of the monograph-source. Associated documentation about the medication. |
monograph_source_reference | String | The reference of the monograph-source. Associated documentation about the medication. |
monograph_source_identifier_value | String | The value of the monograph-source-identifier. Associated documentation about the medication. |
monograph_source_type | String | The monograph-source-type of the monograph-source-type. Associated documentation about the medication. |
ingredient_id | String | The ingredient-id of the ingredient-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ingredient_extension | String | The ingredient-extension of the ingredient-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
ingredient_modifierExtension | String | The ingredient-modifierExtension of the ingredient-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
ingredient_item_x_coding | String | The coding of the ingredient-item[x]. The actual ingredient - either a substance (simple ingredient) or another medication. |
ingredient_item_x_text | String | The text of the ingredient-item[x]. The actual ingredient - either a substance (simple ingredient) or another medication. |
ingredient_isActive | Bool | The ingredient-isActive of the ingredient-isActive. Indication of whether this ingredient affects the therapeutic action of the drug. |
ingredient_strength | String | The ingredient-strength of the ingredient-strength. Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet. |
preparationInstruction | String | The instructions for preparing the medication. |
intendedRoute_coding | String | The coding of the intendedRoute. The intended or approved route of administration. |
intendedRoute_text | String | The text of the intendedRoute. The intended or approved route of administration. |
cost_id | String | The cost-id of the cost-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
cost_extension | String | The cost-extension of the cost-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
cost_modifierExtension | String | The cost-modifierExtension of the cost-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
cost_type_coding | String | The coding of the cost-type. The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost. |
cost_type_text | String | The text of the cost-type. The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost. |
cost_source | String | The cost-source of the cost-source. The source or owner that assigns the price to the medication. |
cost_cost | String | The cost-cost of the cost-cost. The price of the medication. |
monitoringProgram_id | String | The monitoringProgram-id of the monitoringProgram-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
monitoringProgram_extension | String | The monitoringProgram-extension of the monitoringProgram-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
monitoringProgram_modifierExtension | String | The monitoringProgram-modifierExtension of the monitoringProgram-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
monitoringProgram_type_coding | String | The coding of the monitoringProgram-type. Type of program under which the medication is monitored. |
monitoringProgram_type_text | String | The text of the monitoringProgram-type. Type of program under which the medication is monitored. |
monitoringProgram_name | String | The monitoringProgram-name of the monitoringProgram-name. Name of the reviewing program. |
administrationGuidelines_id | String | The administrationGuidelines-id of the administrationGuidelines-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
administrationGuidelines_extension | String | The administrationGuidelines-extension of the administrationGuidelines-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
administrationGuidelines_modifierExtension | String | The administrationGuidelines-modifierExtension of the administrationGuidelines-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
administrationGuidelines_dosage_id | String | The administrationGuidelines-dosage-id of the administrationGuidelines-dosage-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
administrationGuidelines_dosage_extension | String | The administrationGuidelines-dosage-extension of the administrationGuidelines-dosage-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
administrationGuidelines_dosage_modifierExtension | String | The administrationGuidelines-dosage-modifierExtension of the administrationGuidelines-dosage-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
administrationGuidelines_dosage_type_coding | String | The coding of the administrationGuidelines-dosage-type. The type of dosage (for example, prophylaxis, maintenance, therapeutic, etc.). |
administrationGuidelines_dosage_type_text | String | The text of the administrationGuidelines-dosage-type. The type of dosage (for example, prophylaxis, maintenance, therapeutic, etc.). |
administrationGuidelines_dosage_dosage_system | String | The system of the administrationGuidelines-dosage-dosage. Dosage for the medication for the specific guidelines. |
administrationGuidelines_dosage_dosage_comparator | String | The administrationGuidelines-dosage-dosage-comparator of the administrationGuidelines-dosage-dosage-comparator. Dosage for the medication for the specific guidelines. |
administrationGuidelines_indication_x_coding | String | The coding of the administrationGuidelines-indication[x]. Indication for use that apply to the specific administration guidelines. |
administrationGuidelines_indication_x_text | String | The text of the administrationGuidelines-indication[x]. Indication for use that apply to the specific administration guidelines. |
administrationGuidelines_patientCharacteristics_id | String | The administrationGuidelines-patientCharacteristics-id of the administrationGuidelines-patientCharacteristics-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
administrationGuidelines_patientCharacteristics_extension | String | The administrationGuidelines-patientCharacteristics-extension of the administrationGuidelines-patientCharacteristics-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
administrationGuidelines_patientCharacteristics_modifierExtension | String | The administrationGuidelines-patientCharacteristics-modifierExtension of the administrationGuidelines-patientCharacteristics-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
administrationGuidelines_patientCharacteristics_characteristic_x_coding | String | The coding of the administrationGuidelines-patientCharacteristics-characteristic[x]. Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender). |
administrationGuidelines_patientCharacteristics_characteristic_x_text | String | The text of the administrationGuidelines-patientCharacteristics-characteristic[x]. Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender). |
administrationGuidelines_patientCharacteristics_value | String | The administrationGuidelines-patientCharacteristics-value of the administrationGuidelines-patientCharacteristics-value. The specific characteristic (e.g. height, weight, gender, etc.). |
medicineClassification_id | String | The medicineClassification-id of the medicineClassification-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
medicineClassification_extension | String | The medicineClassification-extension of the medicineClassification-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
medicineClassification_modifierExtension | String | The medicineClassification-modifierExtension of the medicineClassification-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
medicineClassification_type_coding | String | The coding of the medicineClassification-type. The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification). |
medicineClassification_type_text | String | The text of the medicineClassification-type. The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification). |
medicineClassification_classification_coding | String | The coding of the medicineClassification-classification. Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.). |
medicineClassification_classification_text | String | The text of the medicineClassification-classification. Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.). |
packaging_id | String | The packaging-id of the packaging-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
packaging_extension | String | The packaging-extension of the packaging-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
packaging_modifierExtension | String | The packaging-modifierExtension of the packaging-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
packaging_type_coding | String | The coding of the packaging-type. A code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle). |
packaging_type_text | String | The text of the packaging-type. A code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle). |
packaging_quantity_value | Decimal | The value of the packaging-quantity. The number of product units the package would contain if fully loaded. |
packaging_quantity_unit | String | The unit of the packaging-quantity. The number of product units the package would contain if fully loaded. |
packaging_quantity_system | String | The system of the packaging-quantity. The number of product units the package would contain if fully loaded. |
packaging_quantity_comparator | String | The packaging-quantity-comparator of the packaging-quantity-comparator. The number of product units the package would contain if fully loaded. |
packaging_quantity_code | String | The packaging-quantity-code of the packaging-quantity-code. The number of product units the package would contain if fully loaded. |
drugCharacteristic_id | String | The drugCharacteristic-id of the drugCharacteristic-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
drugCharacteristic_extension | String | The drugCharacteristic-extension of the drugCharacteristic-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
drugCharacteristic_modifierExtension | String | The drugCharacteristic-modifierExtension of the drugCharacteristic-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
drugCharacteristic_type_coding | String | The coding of the drugCharacteristic-type. A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint). |
drugCharacteristic_type_text | String | The text of the drugCharacteristic-type. A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint). |
drugCharacteristic_value_x_coding | String | The coding of the drugCharacteristic-value[x]. Description of the characteristic. |
drugCharacteristic_value_x_text | String | The text of the drugCharacteristic-value[x]. Description of the characteristic. |
contraindication_display | String | The display of the contraindication. Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.). |
contraindication_reference | String | The reference of the contraindication. Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.). |
contraindication_identifier_value | String | The value of the contraindication-identifier. Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.). |
contraindication_type | String | The contraindication-type of the contraindication-type. Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.). |
regulatory_id | String | The regulatory-id of the regulatory-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
regulatory_extension | String | The regulatory-extension of the regulatory-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
regulatory_modifierExtension | String | The regulatory-modifierExtension of the regulatory-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
regulatory_regulatoryAuthority_display | String | The display of the regulatory-regulatoryAuthority. The authority that is specifying the regulations. |
regulatory_regulatoryAuthority_reference | String | The reference of the regulatory-regulatoryAuthority. The authority that is specifying the regulations. |
regulatory_regulatoryAuthority_identifier_value | String | The value of the regulatory-regulatoryAuthority-identifier. The authority that is specifying the regulations. |
regulatory_regulatoryAuthority_type | String | The regulatory-regulatoryAuthority-type of the regulatory-regulatoryAuthority-type. The authority that is specifying the regulations. |
regulatory_substitution_id | String | The regulatory-substitution-id of the regulatory-substitution-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
regulatory_substitution_extension | String | The regulatory-substitution-extension of the regulatory-substitution-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
regulatory_substitution_modifierExtension | String | The regulatory-substitution-modifierExtension of the regulatory-substitution-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
regulatory_substitution_type_coding | String | The coding of the regulatory-substitution-type. Specifies the type of substitution allowed. |
regulatory_substitution_type_text | String | The text of the regulatory-substitution-type. Specifies the type of substitution allowed. |
regulatory_substitution_allowed | Bool | The regulatory-substitution-allowed of the regulatory-substitution-allowed. Specifies if regulation allows for changes in the medication when dispensing. |
regulatory_schedule_id | String | The regulatory-schedule-id of the regulatory-schedule-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
regulatory_schedule_extension | String | The regulatory-schedule-extension of the regulatory-schedule-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
regulatory_schedule_modifierExtension | String | The regulatory-schedule-modifierExtension of the regulatory-schedule-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
regulatory_schedule_schedule_coding | String | The coding of the regulatory-schedule-schedule. Specifies the specific drug schedule. |
regulatory_schedule_schedule_text | String | The text of the regulatory-schedule-schedule. Specifies the specific drug schedule. |
regulatory_maxDispense_id | String | The regulatory-maxDispense-id of the regulatory-maxDispense-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
regulatory_maxDispense_extension | String | The regulatory-maxDispense-extension of the regulatory-maxDispense-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
regulatory_maxDispense_modifierExtension | String | The regulatory-maxDispense-modifierExtension of the regulatory-maxDispense-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
regulatory_maxDispense_quantity_value | Decimal | The value of the regulatory-maxDispense-quantity. The maximum number of units of the medication that can be dispensed. |
regulatory_maxDispense_quantity_unit | String | The unit of the regulatory-maxDispense-quantity. The maximum number of units of the medication that can be dispensed. |
regulatory_maxDispense_quantity_system | String | The system of the regulatory-maxDispense-quantity. The maximum number of units of the medication that can be dispensed. |
regulatory_maxDispense_quantity_comparator | String | The regulatory-maxDispense-quantity-comparator of the regulatory-maxDispense-quantity-comparator. The maximum number of units of the medication that can be dispensed. |
regulatory_maxDispense_quantity_code | String | The regulatory-maxDispense-quantity-code of the regulatory-maxDispense-quantity-code. The maximum number of units of the medication that can be dispensed. |
regulatory_maxDispense_period | String | The regulatory-maxDispense-period of the regulatory-maxDispense-period. The period that applies to the maximum number of units. |
kinetics_id | String | The kinetics-id of the kinetics-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
kinetics_extension | String | The kinetics-extension of the kinetics-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
kinetics_modifierExtension | String | The kinetics-modifierExtension of the kinetics-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
kinetics_areaUnderCurve_value | String | The value of the kinetics-areaUnderCurve. The drug concentration measured at certain discrete points in time. |
kinetics_areaUnderCurve_unit | String | The unit of the kinetics-areaUnderCurve. The drug concentration measured at certain discrete points in time. |
kinetics_areaUnderCurve_system | String | The system of the kinetics-areaUnderCurve. The drug concentration measured at certain discrete points in time. |
kinetics_areaUnderCurve_comparator | String | The kinetics-areaUnderCurve-comparator of the kinetics-areaUnderCurve-comparator. The drug concentration measured at certain discrete points in time. |
kinetics_areaUnderCurve_code | String | The kinetics-areaUnderCurve-code of the kinetics-areaUnderCurve-code. The drug concentration measured at certain discrete points in time. |
kinetics_lethalDose50_value | String | The value of the kinetics-lethalDose50. The median lethal dose of a drug. |
kinetics_lethalDose50_unit | String | The unit of the kinetics-lethalDose50. The median lethal dose of a drug. |
kinetics_lethalDose50_system | String | The system of the kinetics-lethalDose50. The median lethal dose of a drug. |
kinetics_lethalDose50_comparator | String | The kinetics-lethalDose50-comparator of the kinetics-lethalDose50-comparator. The median lethal dose of a drug. |
kinetics_lethalDose50_code | String | The kinetics-lethalDose50-code of the kinetics-lethalDose50-code. The median lethal dose of a drug. |
kinetics_halfLifePeriod | String | The kinetics-halfLifePeriod of the kinetics-halfLifePeriod. The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by half. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_ingredient_code_end | String | The SP_ingredient_code_end search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_source_cost_start | String | The SP_source_cost_start search parameter. |
SP_doseform_start | String | The SP_doseform_start search parameter. |
SP_monograph_type_start | String | The SP_monograph_type_start search parameter. |
SP_monograph | String | The SP_monograph search parameter. |
SP_list | String | The SP_list search parameter. |
SP_monitoring_program_type_end | String | The SP_monitoring_program_type_end search parameter. |
SP_monitoring_program_type_start | String | The SP_monitoring_program_type_start search parameter. |
SP_classification_end | String | The SP_classification_end search parameter. |
SP_ingredient_code_start | String | The SP_ingredient_code_start search parameter. |
SP_monitoring_program_name_start | String | The SP_monitoring_program_name_start search parameter. |
SP_source_cost_end | String | The SP_source_cost_end search parameter. |
SP_monitoring_program_name_end | String | The SP_monitoring_program_name_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_classification_type_start | String | The SP_classification_type_start search parameter. |
SP_classification_start | String | The SP_classification_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_monograph_type_end | String | The SP_monograph_type_end search parameter. |
SP_classification_type_end | String | The SP_classification_type_end search parameter. |
SP_manufacturer | String | The SP_manufacturer search parameter. |
SP_doseform_end | String | The SP_doseform_end search parameter. |
SP_ingredient | String | The SP_ingredient search parameter. |
MedicationRequest view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
status | String | A code specifying the current state of the order. Generally, this will be active or completed state. |
statusReason_coding | String | The coding of the statusReason. Captures the reason for the current state of the MedicationRequest. |
statusReason_text | String | The text of the statusReason. Captures the reason for the current state of the MedicationRequest. |
intent | String | Whether the request is a proposal, plan, or an original order. |
category_coding | String | The coding of the category. Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)). |
category_text | String | The text of the category. Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)). |
priority | String | Indicates how quickly the Medication Request should be addressed with respect to other requests. |
doNotPerform | Bool | If true indicates that the provider is asking for the medication request not to occur. |
reported_x_ | Bool | Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report. |
medication_x_coding | String | The coding of the medication[x]. Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications. |
medication_x_text | String | The text of the medication[x]. Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications. |
subject_display | String | The display of the subject. A link to a resource representing the person or set of individuals to whom the medication will be given. |
subject_reference | String | The reference of the subject. A link to a resource representing the person or set of individuals to whom the medication will be given. |
subject_identifier_value | String | The value of the subject-identifier. A link to a resource representing the person or set of individuals to whom the medication will be given. |
subject_type | String | The subject-type of the subject-type. A link to a resource representing the person or set of individuals to whom the medication will be given. |
encounter_display | String | The display of the encounter. The Encounter during which this [x] was created or to which the creation of this record is tightly associated. |
encounter_reference | String | The reference of the encounter. The Encounter during which this [x] was created or to which the creation of this record is tightly associated. |
encounter_identifier_value | String | The value of the encounter-identifier. The Encounter during which this [x] was created or to which the creation of this record is tightly associated. |
encounter_type | String | The encounter-type of the encounter-type. The Encounter during which this [x] was created or to which the creation of this record is tightly associated. |
supportingInformation_display | String | The display of the supportingInformation. Include additional information (for example, patient height and weight) that supports the ordering of the medication. |
supportingInformation_reference | String | The reference of the supportingInformation. Include additional information (for example, patient height and weight) that supports the ordering of the medication. |
supportingInformation_identifier_value | String | The value of the supportingInformation-identifier. Include additional information (for example, patient height and weight) that supports the ordering of the medication. |
supportingInformation_type | String | The supportingInformation-type of the supportingInformation-type. Include additional information (for example, patient height and weight) that supports the ordering of the medication. |
authoredOn | Datetime | The date (and perhaps time) when the prescription was initially written or authored on. |
requester_display | String | The display of the requester. The individual, organization, or device that initiated the request and has responsibility for its activation. |
requester_reference | String | The reference of the requester. The individual, organization, or device that initiated the request and has responsibility for its activation. |
requester_identifier_value | String | The value of the requester-identifier. The individual, organization, or device that initiated the request and has responsibility for its activation. |
requester_type | String | The requester-type of the requester-type. The individual, organization, or device that initiated the request and has responsibility for its activation. |
performer_display | String | The display of the performer. The specified desired performer of the medication treatment (e.g. the performer of the medication administration). |
performer_reference | String | The reference of the performer. The specified desired performer of the medication treatment (e.g. the performer of the medication administration). |
performer_identifier_value | String | The value of the performer-identifier. The specified desired performer of the medication treatment (e.g. the performer of the medication administration). |
performer_type | String | The performer-type of the performer-type. The specified desired performer of the medication treatment (e.g. the performer of the medication administration). |
performerType_coding | String | The coding of the performerType. Indicates the type of performer of the administration of the medication. |
performerType_text | String | The text of the performerType. Indicates the type of performer of the administration of the medication. |
recorder_display | String | The display of the recorder. The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order. |
recorder_reference | String | The reference of the recorder. The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order. |
recorder_identifier_value | String | The value of the recorder-identifier. The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order. |
recorder_type | String | The recorder-type of the recorder-type. The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order. |
reasonCode_coding | String | The coding of the reasonCode. The reason or the indication for ordering or not ordering the medication. |
reasonCode_text | String | The text of the reasonCode. The reason or the indication for ordering or not ordering the medication. |
reasonReference_display | String | The display of the reasonReference. Condition or observation that supports why the medication was ordered. |
reasonReference_reference | String | The reference of the reasonReference. Condition or observation that supports why the medication was ordered. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Condition or observation that supports why the medication was ordered. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Condition or observation that supports why the medication was ordered. |
instantiatesCanonical | String | The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest. |
instantiatesUri | String | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest. |
basedOn_display | String | The display of the basedOn. A plan or request that is fulfilled in whole or in part by this medication request. |
basedOn_reference | String | The reference of the basedOn. A plan or request that is fulfilled in whole or in part by this medication request. |
basedOn_identifier_value | String | The value of the basedOn-identifier. A plan or request that is fulfilled in whole or in part by this medication request. |
basedOn_type | String | The basedOn-type of the basedOn-type. A plan or request that is fulfilled in whole or in part by this medication request. |
groupIdentifier_value | String | The value of the groupIdentifier. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription. |
groupIdentifier_use | String | The groupIdentifier-use of the groupIdentifier-use. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription. |
groupIdentifier_type_coding | String | The coding of the groupIdentifier-type. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription. |
groupIdentifier_type_text | String | The text of the groupIdentifier-type. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription. |
groupIdentifier_system | String | The groupIdentifier-system of the groupIdentifier-system. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription. |
groupIdentifier_period_start | Datetime | The start of the groupIdentifier-period. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription. |
groupIdentifier_period_end | Datetime | The end of the groupIdentifier-period. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription. |
courseOfTherapyType_coding | String | The coding of the courseOfTherapyType. The description of the overall patte3rn of the administration of the medication to the patient. |
courseOfTherapyType_text | String | The text of the courseOfTherapyType. The description of the overall patte3rn of the administration of the medication to the patient. |
insurance_display | String | The display of the insurance. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. |
insurance_reference | String | The reference of the insurance. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. |
insurance_identifier_value | String | The value of the insurance-identifier. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. |
insurance_type | String | The insurance-type of the insurance-type. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. |
note | String | Extra information about the prescription that could not be conveyed by the other attributes. |
dosageInstruction_system | String | The system of the dosageInstruction. Indicates how the medication is to be used by the patient. |
dosageInstruction_comparator | String | The dosageInstruction-comparator of the dosageInstruction-comparator. Indicates how the medication is to be used by the patient. |
dispenseRequest_id | String | The dispenseRequest-id of the dispenseRequest-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
dispenseRequest_extension | String | The dispenseRequest-extension of the dispenseRequest-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
dispenseRequest_modifierExtension | String | The dispenseRequest-modifierExtension of the dispenseRequest-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
dispenseRequest_initialFill_id | String | The dispenseRequest-initialFill-id of the dispenseRequest-initialFill-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
dispenseRequest_initialFill_extension | String | The dispenseRequest-initialFill-extension of the dispenseRequest-initialFill-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
dispenseRequest_initialFill_modifierExtension | String | The dispenseRequest-initialFill-modifierExtension of the dispenseRequest-initialFill-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
dispenseRequest_initialFill_quantity_value | Decimal | The value of the dispenseRequest-initialFill-quantity. The amount or quantity to provide as part of the first dispense. |
dispenseRequest_initialFill_quantity_unit | String | The unit of the dispenseRequest-initialFill-quantity. The amount or quantity to provide as part of the first dispense. |
dispenseRequest_initialFill_quantity_system | String | The system of the dispenseRequest-initialFill-quantity. The amount or quantity to provide as part of the first dispense. |
dispenseRequest_initialFill_quantity_comparator | String | The dispenseRequest-initialFill-quantity-comparator of the dispenseRequest-initialFill-quantity-comparator. The amount or quantity to provide as part of the first dispense. |
dispenseRequest_initialFill_quantity_code | String | The dispenseRequest-initialFill-quantity-code of the dispenseRequest-initialFill-quantity-code. The amount or quantity to provide as part of the first dispense. |
dispenseRequest_initialFill_duration | String | The dispenseRequest-initialFill-duration of the dispenseRequest-initialFill-duration. The length of time that the first dispense is expected to last. |
dispenseRequest_dispenseInterval | String | The dispenseRequest-dispenseInterval of the dispenseRequest-dispenseInterval. The minimum period of time that must occur between dispenses of the medication. |
dispenseRequest_validityPeriod_start | Datetime | The start of the dispenseRequest-validityPeriod. This indicates the validity period of a prescription (stale dating the Prescription). |
dispenseRequest_validityPeriod_end | Datetime | The end of the dispenseRequest-validityPeriod. This indicates the validity period of a prescription (stale dating the Prescription). |
dispenseRequest_numberOfRepeatsAllowed | String | The dispenseRequest-numberOfRepeatsAllowed of the dispenseRequest-numberOfRepeatsAllowed. An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus '3 repeats', then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense. |
dispenseRequest_quantity_value | Decimal | The value of the dispenseRequest-quantity. The amount that is to be dispensed for one fill. |
dispenseRequest_quantity_unit | String | The unit of the dispenseRequest-quantity. The amount that is to be dispensed for one fill. |
dispenseRequest_quantity_system | String | The system of the dispenseRequest-quantity. The amount that is to be dispensed for one fill. |
dispenseRequest_quantity_comparator | String | The dispenseRequest-quantity-comparator of the dispenseRequest-quantity-comparator. The amount that is to be dispensed for one fill. |
dispenseRequest_quantity_code | String | The dispenseRequest-quantity-code of the dispenseRequest-quantity-code. The amount that is to be dispensed for one fill. |
dispenseRequest_expectedSupplyDuration | String | The dispenseRequest-expectedSupplyDuration of the dispenseRequest-expectedSupplyDuration. Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. |
dispenseRequest_performer_display | String | The display of the dispenseRequest-performer. Indicates the intended dispensing Organization specified by the prescriber. |
dispenseRequest_performer_reference | String | The reference of the dispenseRequest-performer. Indicates the intended dispensing Organization specified by the prescriber. |
dispenseRequest_performer_identifier_value | String | The value of the dispenseRequest-performer-identifier. Indicates the intended dispensing Organization specified by the prescriber. |
dispenseRequest_performer_type | String | The dispenseRequest-performer-type of the dispenseRequest-performer-type. Indicates the intended dispensing Organization specified by the prescriber. |
substitution_id | String | The substitution-id of the substitution-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
substitution_extension | String | The substitution-extension of the substitution-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
substitution_modifierExtension | String | The substitution-modifierExtension of the substitution-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
substitution_allowed_x_ | Bool | The substitution-allowed[x] of the substitution-allowed[x]. True if the prescriber allows a different drug to be dispensed from what was prescribed. |
substitution_reason_coding | String | The coding of the substitution-reason. Indicates the reason for the substitution, or why substitution must or must not be performed. |
substitution_reason_text | String | The text of the substitution-reason. Indicates the reason for the substitution, or why substitution must or must not be performed. |
priorPrescription_display | String | The display of the priorPrescription. A link to a resource representing an earlier order related order or prescription. |
priorPrescription_reference | String | The reference of the priorPrescription. A link to a resource representing an earlier order related order or prescription. |
priorPrescription_identifier_value | String | The value of the priorPrescription-identifier. A link to a resource representing an earlier order related order or prescription. |
priorPrescription_type | String | The priorPrescription-type of the priorPrescription-type. A link to a resource representing an earlier order related order or prescription. |
detectedIssue_display | String | The display of the detectedIssue. Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc. |
detectedIssue_reference | String | The reference of the detectedIssue. Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc. |
detectedIssue_identifier_value | String | The value of the detectedIssue-identifier. Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc. |
detectedIssue_type | String | The detectedIssue-type of the detectedIssue-type. Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc. |
eventHistory_display | String | The display of the eventHistory. Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource. |
eventHistory_reference | String | The reference of the eventHistory. Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource. |
eventHistory_identifier_value | String | The value of the eventHistory-identifier. Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource. |
eventHistory_type | String | The eventHistory-type of the eventHistory-type. Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource. |
SP_source | String | The SP_source search parameter. |
SP_medication | String | The SP_medication search parameter. |
SP_intended_performertype_start | String | The SP_intended_performertype_start search parameter. |
SP_text | String | The SP_text search parameter. |
SP_intended_performertype_end | String | The SP_intended_performertype_end search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_intended_dispenser | String | The SP_intended_dispenser search parameter. |
SP_intended_performer | String | The SP_intended_performer search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_date | String | The SP_date search parameter. |
SP_requester | String | The SP_requester search parameter. |
MedicationStatement view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
basedOn_display | String | The display of the basedOn. A plan, proposal or order that is fulfilled in whole or in part by this event. |
basedOn_reference | String | The reference of the basedOn. A plan, proposal or order that is fulfilled in whole or in part by this event. |
basedOn_identifier_value | String | The value of the basedOn-identifier. A plan, proposal or order that is fulfilled in whole or in part by this event. |
basedOn_type | String | The basedOn-type of the basedOn-type. A plan, proposal or order that is fulfilled in whole or in part by this event. |
partOf_display | String | The display of the partOf. A larger event of which this particular event is a component or step. |
partOf_reference | String | The reference of the partOf. A larger event of which this particular event is a component or step. |
partOf_identifier_value | String | The value of the partOf-identifier. A larger event of which this particular event is a component or step. |
partOf_type | String | The partOf-type of the partOf-type. A larger event of which this particular event is a component or step. |
status | String | A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed. |
statusReason_coding | String | The coding of the statusReason. Captures the reason for the current state of the MedicationStatement. |
statusReason_text | String | The text of the statusReason. Captures the reason for the current state of the MedicationStatement. |
category_coding | String | The coding of the category. Indicates where the medication is expected to be consumed or administered. |
category_text | String | The text of the category. Indicates where the medication is expected to be consumed or administered. |
medication_x_coding | String | The coding of the medication[x]. Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
medication_x_text | String | The text of the medication[x]. Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
subject_display | String | The display of the subject. The person, animal or group who is/was taking the medication. |
subject_reference | String | The reference of the subject. The person, animal or group who is/was taking the medication. |
subject_identifier_value | String | The value of the subject-identifier. The person, animal or group who is/was taking the medication. |
subject_type | String | The subject-type of the subject-type. The person, animal or group who is/was taking the medication. |
context_display | String | The display of the context. The encounter or episode of care that establishes the context for this MedicationStatement. |
context_reference | String | The reference of the context. The encounter or episode of care that establishes the context for this MedicationStatement. |
context_identifier_value | String | The value of the context-identifier. The encounter or episode of care that establishes the context for this MedicationStatement. |
context_type | String | The context-type of the context-type. The encounter or episode of care that establishes the context for this MedicationStatement. |
effective_x_ | Datetime | The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No). |
dateAsserted | Datetime | The date when the medication statement was asserted by the information source. |
informationSource_display | String | The display of the informationSource. The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest. |
informationSource_reference | String | The reference of the informationSource. The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest. |
informationSource_identifier_value | String | The value of the informationSource-identifier. The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest. |
informationSource_type | String | The informationSource-type of the informationSource-type. The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest. |
derivedFrom_display | String | The display of the derivedFrom. Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement. |
derivedFrom_reference | String | The reference of the derivedFrom. Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement. |
derivedFrom_identifier_value | String | The value of the derivedFrom-identifier. Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement. |
derivedFrom_type | String | The derivedFrom-type of the derivedFrom-type. Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement. |
reasonCode_coding | String | The coding of the reasonCode. A reason for why the medication is being/was taken. |
reasonCode_text | String | The text of the reasonCode. A reason for why the medication is being/was taken. |
reasonReference_display | String | The display of the reasonReference. Condition or observation that supports why the medication is being/was taken. |
reasonReference_reference | String | The reference of the reasonReference. Condition or observation that supports why the medication is being/was taken. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Condition or observation that supports why the medication is being/was taken. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Condition or observation that supports why the medication is being/was taken. |
note | String | Provides extra information about the medication statement that is not conveyed by the other attributes. |
dosage_system | String | The system of the dosage. Indicates how the medication is/was or should be taken by the patient. |
dosage_comparator | String | The dosage-comparator of the dosage-comparator. Indicates how the medication is/was or should be taken by the patient. |
SP_source | String | The SP_source search parameter. |
SP_medication | String | The SP_medication search parameter. |
SP_context | String | The SP_context search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_effective | String | The SP_effective search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_part_of | String | The SP_part_of search parameter. |
SP_filter | String | The SP_filter search parameter. |
MedicinalProductDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifier for this product. Could be an MPID. |
identifier_use | String | The identifier-use of the identifier-use. Business identifier for this product. Could be an MPID. |
identifier_type_coding | String | The coding of the identifier-type. Business identifier for this product. Could be an MPID. |
identifier_type_text | String | The text of the identifier-type. Business identifier for this product. Could be an MPID. |
identifier_system | String | The identifier-system of the identifier-system. Business identifier for this product. Could be an MPID. |
identifier_period_start | String | The start of the identifier-period. Business identifier for this product. Could be an MPID. |
identifier_period_end | String | The end of the identifier-period. Business identifier for this product. Could be an MPID. |
type_coding | String | The coding of the type. Regulatory type, e.g. Investigational or Authorized. |
type_text | String | The text of the type. Regulatory type, e.g. Investigational or Authorized. |
domain_coding | String | The coding of the domain. If this medicine applies to human or veterinary uses. |
domain_text | String | The text of the domain. If this medicine applies to human or veterinary uses. |
version | String | A business identifier relating to a specific version of the product, this is commonly used to support revisions to an existing product. |
status_coding | String | The coding of the status. The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status. |
status_text | String | The text of the status. The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status. |
statusDate | Datetime | The date at which the given status became applicable. |
description | String | General description of this product. |
combinedPharmaceuticalDoseForm_coding | String | The coding of the combinedPharmaceuticalDoseForm. The dose form for a single part product, or combined form of a multiple part product. |
combinedPharmaceuticalDoseForm_text | String | The text of the combinedPharmaceuticalDoseForm. The dose form for a single part product, or combined form of a multiple part product. |
route_coding | String | The coding of the route. The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. See also AdministrableProductDefinition resource. |
route_text | String | The text of the route. The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. See also AdministrableProductDefinition resource. |
indication | String | Description of indication(s) for this product, used when structured indications are not required. In cases where structured indications are required, they are captured using the ClinicalUseDefinition resource. An indication is a medical situation for which using the product is appropriate. |
legalStatusOfSupply_coding | String | The coding of the legalStatusOfSupply. The legal status of supply of the medicinal product as classified by the regulator. |
legalStatusOfSupply_text | String | The text of the legalStatusOfSupply. The legal status of supply of the medicinal product as classified by the regulator. |
additionalMonitoringIndicator_coding | String | The coding of the additionalMonitoringIndicator. Whether the Medicinal Product is subject to additional monitoring for regulatory reasons. |
additionalMonitoringIndicator_text | String | The text of the additionalMonitoringIndicator. Whether the Medicinal Product is subject to additional monitoring for regulatory reasons. |
specialMeasures_coding | String | The coding of the specialMeasures. Whether the Medicinal Product is subject to special measures for regulatory reasons. |
specialMeasures_text | String | The text of the specialMeasures. Whether the Medicinal Product is subject to special measures for regulatory reasons. |
pediatricUseIndicator_coding | String | The coding of the pediatricUseIndicator. If authorised for use in children. |
pediatricUseIndicator_text | String | The text of the pediatricUseIndicator. If authorised for use in children. |
classification_coding | String | The coding of the classification. Allows the product to be classified by various systems. |
classification_text | String | The text of the classification. Allows the product to be classified by various systems. |
marketingStatus | String | Marketing status of the medicinal product, in contrast to marketing authorization. |
packagedMedicinalProduct_coding | String | The coding of the packagedMedicinalProduct. Package representation for the product. See also the PackagedProductDefinition resource. |
packagedMedicinalProduct_text | String | The text of the packagedMedicinalProduct. Package representation for the product. See also the PackagedProductDefinition resource. |
ingredient_coding | String | The coding of the ingredient. The ingredients of this medicinal product - when not detailed in other resources. This is only needed if the ingredients are not specified by incoming references from the Ingredient resource, or indirectly via incoming AdministrableProductDefinition, PackagedProductDefinition or ManufacturedItemDefinition references. In cases where those levels of detail are not used, the ingredients may be specified directly here as codes. |
ingredient_text | String | The text of the ingredient. The ingredients of this medicinal product - when not detailed in other resources. This is only needed if the ingredients are not specified by incoming references from the Ingredient resource, or indirectly via incoming AdministrableProductDefinition, PackagedProductDefinition or ManufacturedItemDefinition references. In cases where those levels of detail are not used, the ingredients may be specified directly here as codes. |
impurity_display | String | The display of the impurity. Any component of the drug product which is not the chemical entity defined as the drug substance or an excipient in the drug product. This includes process-related impurities and contaminants, product-related impurities including degradation products. |
impurity_reference | String | The reference of the impurity. Any component of the drug product which is not the chemical entity defined as the drug substance or an excipient in the drug product. This includes process-related impurities and contaminants, product-related impurities including degradation products. |
impurity_identifier_value | String | The value of the impurity-identifier. Any component of the drug product which is not the chemical entity defined as the drug substance or an excipient in the drug product. This includes process-related impurities and contaminants, product-related impurities including degradation products. |
impurity_type | String | The impurity-type of the impurity-type. Any component of the drug product which is not the chemical entity defined as the drug substance or an excipient in the drug product. This includes process-related impurities and contaminants, product-related impurities including degradation products. |
attachedDocument_display | String | The display of the attachedDocument. Additional information or supporting documentation about the medicinal product. |
attachedDocument_reference | String | The reference of the attachedDocument. Additional information or supporting documentation about the medicinal product. |
attachedDocument_identifier_value | String | The value of the attachedDocument-identifier. Additional information or supporting documentation about the medicinal product. |
attachedDocument_type | String | The attachedDocument-type of the attachedDocument-type. Additional information or supporting documentation about the medicinal product. |
masterFile_display | String | The display of the masterFile. A master file for the medicinal product (e.g. Pharmacovigilance System Master File). Drug master files (DMFs) are documents submitted to regulatory agencies to provide confidential detailed information about facilities, processes or articles used in the manufacturing, processing, packaging and storing of drug products. |
masterFile_reference | String | The reference of the masterFile. A master file for the medicinal product (e.g. Pharmacovigilance System Master File). Drug master files (DMFs) are documents submitted to regulatory agencies to provide confidential detailed information about facilities, processes or articles used in the manufacturing, processing, packaging and storing of drug products. |
masterFile_identifier_value | String | The value of the masterFile-identifier. A master file for the medicinal product (e.g. Pharmacovigilance System Master File). Drug master files (DMFs) are documents submitted to regulatory agencies to provide confidential detailed information about facilities, processes or articles used in the manufacturing, processing, packaging and storing of drug products. |
masterFile_type | String | The masterFile-type of the masterFile-type. A master file for the medicinal product (e.g. Pharmacovigilance System Master File). Drug master files (DMFs) are documents submitted to regulatory agencies to provide confidential detailed information about facilities, processes or articles used in the manufacturing, processing, packaging and storing of drug products. |
contact_id | String | The contact-id of the contact-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
contact_extension | String | The contact-extension of the contact-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
contact_modifierExtension | String | The contact-modifierExtension of the contact-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
contact_type_coding | String | The coding of the contact-type. Allows the contact to be classified, for example QPPV, Pharmacovigilance Enquiry Information. |
contact_type_text | String | The text of the contact-type. Allows the contact to be classified, for example QPPV, Pharmacovigilance Enquiry Information. |
contact_contact_display | String | The display of the contact-contact. A product specific contact, person (in a role), or an organization. |
contact_contact_reference | String | The reference of the contact-contact. A product specific contact, person (in a role), or an organization. |
contact_contact_identifier_value | String | The value of the contact-contact-identifier. A product specific contact, person (in a role), or an organization. |
contact_contact_type | String | The contact-contact-type of the contact-contact-type. A product specific contact, person (in a role), or an organization. |
clinicalTrial_display | String | The display of the clinicalTrial. Clinical trials or studies that this product is involved in. |
clinicalTrial_reference | String | The reference of the clinicalTrial. Clinical trials or studies that this product is involved in. |
clinicalTrial_identifier_value | String | The value of the clinicalTrial-identifier. Clinical trials or studies that this product is involved in. |
clinicalTrial_type | String | The clinicalTrial-type of the clinicalTrial-type. Clinical trials or studies that this product is involved in. |
code_version | String | The version of the code. A code that this product is known by, usually within some formal terminology. Products (types of medications) tend to be known by identifiers during development and within regulatory process. However when they are prescribed they tend to be identified by codes. The same product may be have multiple codes, applied to it by multiple organizations. |
code | String | A code that this product is known by, usually within some formal terminology. Products (types of medications) tend to be known by identifiers during development and within regulatory process. However when they are prescribed they tend to be identified by codes. The same product may be have multiple codes, applied to it by multiple organizations. |
code_display | String | The display of the code. A code that this product is known by, usually within some formal terminology. Products (types of medications) tend to be known by identifiers during development and within regulatory process. However when they are prescribed they tend to be identified by codes. The same product may be have multiple codes, applied to it by multiple organizations. |
code_userSelected | String | The userSelected of the code. A code that this product is known by, usually within some formal terminology. Products (types of medications) tend to be known by identifiers during development and within regulatory process. However when they are prescribed they tend to be identified by codes. The same product may be have multiple codes, applied to it by multiple organizations. |
code_system | String | The code-system of the code-system. A code that this product is known by, usually within some formal terminology. Products (types of medications) tend to be known by identifiers during development and within regulatory process. However when they are prescribed they tend to be identified by codes. The same product may be have multiple codes, applied to it by multiple organizations. |
name_id | String | The name-id of the name-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
name_extension | String | The name-extension of the name-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
name_modifierExtension | String | The name-modifierExtension of the name-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
name_productName | String | The name-productName of the name-productName. The full product name. |
name_type_coding | String | The coding of the name-type. Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary. |
name_type_text | String | The text of the name-type. Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary. |
name_namePart_id | String | The name-namePart-id of the name-namePart-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
name_namePart_extension | String | The name-namePart-extension of the name-namePart-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
name_namePart_modifierExtension | String | The name-namePart-modifierExtension of the name-namePart-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
name_namePart_part | String | The name-namePart-part of the name-namePart-part. A fragment of a product name. |
name_namePart_type_coding | String | The coding of the name-namePart-type. Identifying type for this part of the name (e.g. strength part). |
name_namePart_type_text | String | The text of the name-namePart-type. Identifying type for this part of the name (e.g. strength part). |
name_countryLanguage_id | String | The name-countryLanguage-id of the name-countryLanguage-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
name_countryLanguage_extension | String | The name-countryLanguage-extension of the name-countryLanguage-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
name_countryLanguage_modifierExtension | String | The name-countryLanguage-modifierExtension of the name-countryLanguage-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
name_countryLanguage_country_coding | String | The coding of the name-countryLanguage-country. Country code for where this name applies. |
name_countryLanguage_country_text | String | The text of the name-countryLanguage-country. Country code for where this name applies. |
name_countryLanguage_jurisdiction_coding | String | The coding of the name-countryLanguage-jurisdiction. Jurisdiction code for where this name applies. |
name_countryLanguage_jurisdiction_text | String | The text of the name-countryLanguage-jurisdiction. Jurisdiction code for where this name applies. |
name_countryLanguage_language_coding | String | The coding of the name-countryLanguage-language. Language code for this name. |
name_countryLanguage_language_text | String | The text of the name-countryLanguage-language. Language code for this name. |
crossReference_id | String | The crossReference-id of the crossReference-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
crossReference_extension | String | The crossReference-extension of the crossReference-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
crossReference_modifierExtension | String | The crossReference-modifierExtension of the crossReference-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
crossReference_product_display | String | The display of the crossReference-product. Reference to another product, e.g. for linking authorised to investigational product. |
crossReference_product_reference | String | The reference of the crossReference-product. Reference to another product, e.g. for linking authorised to investigational product. |
crossReference_product_identifier_value | String | The value of the crossReference-product-identifier. Reference to another product, e.g. for linking authorised to investigational product. |
crossReference_product_type | String | The crossReference-product-type of the crossReference-product-type. Reference to another product, e.g. for linking authorised to investigational product. |
crossReference_type_coding | String | The coding of the crossReference-type. The type of relationship, for instance branded to generic, product to development product (investigational), parallel import version. |
crossReference_type_text | String | The text of the crossReference-type. The type of relationship, for instance branded to generic, product to development product (investigational), parallel import version. |
operation_id | String | The operation-id of the operation-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
operation_extension | String | The operation-extension of the operation-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
operation_modifierExtension | String | The operation-modifierExtension of the operation-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
operation_type_display | String | The display of the operation-type. The type of manufacturing operation e.g. manufacturing itself, re-packaging. For the authorization of this, a RegulatedAuthorization would point to the same plan or activity referenced here. |
operation_type_reference | String | The reference of the operation-type. The type of manufacturing operation e.g. manufacturing itself, re-packaging. For the authorization of this, a RegulatedAuthorization would point to the same plan or activity referenced here. |
operation_type_identifier_value | String | The value of the operation-type-identifier. The type of manufacturing operation e.g. manufacturing itself, re-packaging. For the authorization of this, a RegulatedAuthorization would point to the same plan or activity referenced here. |
operation_type_type | String | The operation-type-type of the operation-type-type. The type of manufacturing operation e.g. manufacturing itself, re-packaging. For the authorization of this, a RegulatedAuthorization would point to the same plan or activity referenced here. |
operation_effectiveDate_start | Datetime | The start of the operation-effectiveDate. Date range of applicability. |
operation_effectiveDate_end | Datetime | The end of the operation-effectiveDate. Date range of applicability. |
operation_organization_display | String | The display of the operation-organization. The organization or establishment responsible for (or associated with) the particular process or step, examples include the manufacturer, importer, agent. |
operation_organization_reference | String | The reference of the operation-organization. The organization or establishment responsible for (or associated with) the particular process or step, examples include the manufacturer, importer, agent. |
operation_organization_identifier_value | String | The value of the operation-organization-identifier. The organization or establishment responsible for (or associated with) the particular process or step, examples include the manufacturer, importer, agent. |
operation_organization_type | String | The operation-organization-type of the operation-organization-type. The organization or establishment responsible for (or associated with) the particular process or step, examples include the manufacturer, importer, agent. |
operation_confidentialityIndicator_coding | String | The coding of the operation-confidentialityIndicator. Specifies whether this particular business or manufacturing process is considered proprietary or confidential. |
operation_confidentialityIndicator_text | String | The text of the operation-confidentialityIndicator. Specifies whether this particular business or manufacturing process is considered proprietary or confidential. |
characteristic_id | String | The characteristic-id of the characteristic-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
characteristic_extension | String | The characteristic-extension of the characteristic-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
characteristic_modifierExtension | String | The characteristic-modifierExtension of the characteristic-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
characteristic_type_coding | String | The coding of the characteristic-type. A code expressing the type of characteristic. |
characteristic_type_text | String | The text of the characteristic-type. A code expressing the type of characteristic. |
characteristic_value_x_coding | String | The coding of the characteristic-value[x]. A value for the characteristic. |
characteristic_value_x_text | String | The text of the characteristic-value[x]. A value for the characteristic. |
SP_source | String | The SP_source search parameter. |
SP_characteristic_start | String | The SP_characteristic_start search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_status_start | String | The SP_status_start search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_name_language_start | String | The SP_name_language_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_product_classification_end | String | The SP_product_classification_end search parameter. |
SP_status_end | String | The SP_status_end search parameter. |
SP_characteristic_type_end | String | The SP_characteristic_type_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_master_file | String | The SP_master_file search parameter. |
SP_domain_end | String | The SP_domain_end search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_characteristic_type_start | String | The SP_characteristic_type_start search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_product_classification_start | String | The SP_product_classification_start search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_characteristic_end | String | The SP_characteristic_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_contact | String | The SP_contact search parameter. |
SP_name_language_end | String | The SP_name_language_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_domain_start | String | The SP_domain_start search parameter. |
SP_ingredient_start | String | The SP_ingredient_start search parameter. |
SP_ingredient_end | String | The SP_ingredient_end search parameter. |
SP_name | String | The SP_name search parameter. |
NutritionProduct view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
status | String | The current state of the product. |
category_coding | String | The coding of the category. Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc. |
category_text | String | The text of the category. Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc. |
code_coding | String | The coding of the code. The code assigned to the product, for example a manufacturer number or other terminology. |
code_text | String | The text of the code. The code assigned to the product, for example a manufacturer number or other terminology. |
manufacturer_display | String | The display of the manufacturer. The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device. |
manufacturer_reference | String | The reference of the manufacturer. The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device. |
manufacturer_identifier_value | String | The value of the manufacturer-identifier. The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device. |
manufacturer_type | String | The manufacturer-type of the manufacturer-type. The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device. |
nutrient_id | String | The nutrient-id of the nutrient-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
nutrient_extension | String | The nutrient-extension of the nutrient-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
nutrient_modifierExtension | String | The nutrient-modifierExtension of the nutrient-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
nutrient_item_display | String | The display of the nutrient-item. The (relevant) nutrients in the product. |
nutrient_item_reference | String | The reference of the nutrient-item. The (relevant) nutrients in the product. |
nutrient_item_identifier_value | String | The value of the nutrient-item-identifier. The (relevant) nutrients in the product. |
nutrient_item_type | String | The nutrient-item-type of the nutrient-item-type. The (relevant) nutrients in the product. |
nutrient_amount | String | The nutrient-amount of the nutrient-amount. The amount of nutrient expressed in one or more units: X per pack / per serving / per dose. |
ingredient_id | String | The ingredient-id of the ingredient-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ingredient_extension | String | The ingredient-extension of the ingredient-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
ingredient_modifierExtension | String | The ingredient-modifierExtension of the ingredient-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
ingredient_item_display | String | The display of the ingredient-item. The ingredient contained in the product. |
ingredient_item_reference | String | The reference of the ingredient-item. The ingredient contained in the product. |
ingredient_item_identifier_value | String | The value of the ingredient-item-identifier. The ingredient contained in the product. |
ingredient_item_type | String | The ingredient-item-type of the ingredient-item-type. The ingredient contained in the product. |
ingredient_amount | String | The ingredient-amount of the ingredient-amount. The amount of ingredient that is in the product. |
knownAllergen_display | String | The display of the knownAllergen. Allergens that are known or suspected to be a part of this nutrition product. |
knownAllergen_reference | String | The reference of the knownAllergen. Allergens that are known or suspected to be a part of this nutrition product. |
knownAllergen_identifier_value | String | The value of the knownAllergen-identifier. Allergens that are known or suspected to be a part of this nutrition product. |
knownAllergen_type | String | The knownAllergen-type of the knownAllergen-type. Allergens that are known or suspected to be a part of this nutrition product. |
productCharacteristic_id | String | The productCharacteristic-id of the productCharacteristic-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
productCharacteristic_extension | String | The productCharacteristic-extension of the productCharacteristic-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
productCharacteristic_modifierExtension | String | The productCharacteristic-modifierExtension of the productCharacteristic-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
productCharacteristic_type_coding | String | The coding of the productCharacteristic-type. A code specifying which characteristic of the product is being described (for example, colour, shape). |
productCharacteristic_type_text | String | The text of the productCharacteristic-type. A code specifying which characteristic of the product is being described (for example, colour, shape). |
productCharacteristic_value_x_coding | String | The coding of the productCharacteristic-value[x]. The actual characteristic value corresponding to the type. |
productCharacteristic_value_x_text | String | The text of the productCharacteristic-value[x]. The actual characteristic value corresponding to the type. |
instance_id | String | The instance-id of the instance-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
instance_extension | String | The instance-extension of the instance-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
instance_modifierExtension | String | The instance-modifierExtension of the instance-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
instance_quantity_value | Decimal | The value of the instance-quantity. The amount of items or instances that the resource considers, for instance when referring to 2 identical units together. |
instance_quantity_unit | String | The unit of the instance-quantity. The amount of items or instances that the resource considers, for instance when referring to 2 identical units together. |
instance_quantity_system | String | The system of the instance-quantity. The amount of items or instances that the resource considers, for instance when referring to 2 identical units together. |
instance_quantity_comparator | String | The instance-quantity-comparator of the instance-quantity-comparator. The amount of items or instances that the resource considers, for instance when referring to 2 identical units together. |
instance_quantity_code | String | The instance-quantity-code of the instance-quantity-code. The amount of items or instances that the resource considers, for instance when referring to 2 identical units together. |
instance_identifier_value | String | The value of the instance-identifier. The identifier for the physical instance, typically a serial number. |
instance_identifier_use | String | The instance-identifier-use of the instance-identifier-use. The identifier for the physical instance, typically a serial number. |
instance_identifier_type_coding | String | The coding of the instance-identifier-type. The identifier for the physical instance, typically a serial number. |
instance_identifier_type_text | String | The text of the instance-identifier-type. The identifier for the physical instance, typically a serial number. |
instance_identifier_system | String | The instance-identifier-system of the instance-identifier-system. The identifier for the physical instance, typically a serial number. |
instance_identifier_period_start | String | The start of the instance-identifier-period. The identifier for the physical instance, typically a serial number. |
instance_identifier_period_end | String | The end of the instance-identifier-period. The identifier for the physical instance, typically a serial number. |
instance_lotNumber | String | The instance-lotNumber of the instance-lotNumber. The identification of the batch or lot of the product. |
instance_expiry | Datetime | The instance-expiry of the instance-expiry. The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed. |
instance_useBy | Datetime | The instance-useBy of the instance-useBy. The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed. |
note | String | Comments made about the product. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
Observation view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique identifier assigned to this observation. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this observation. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this observation. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this observation. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this observation. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this observation. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this observation. |
basedOn_display | String | The display of the basedOn. A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. |
basedOn_reference | String | The reference of the basedOn. A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. |
basedOn_identifier_value | String | The value of the basedOn-identifier. A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. |
basedOn_type | String | The basedOn-type of the basedOn-type. A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. |
partOf_display | String | The display of the partOf. A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
partOf_reference | String | The reference of the partOf. A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
partOf_identifier_value | String | The value of the partOf-identifier. A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
partOf_type | String | The partOf-type of the partOf-type. A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
status | String | The status of the result value. |
category_coding | String | The coding of the category. A code that classifies the general type of observation being made. |
category_text | String | The text of the category. A code that classifies the general type of observation being made. |
code_coding | String | The coding of the code. Describes what was observed. Sometimes this is called the observation 'name'. |
code_text | String | The text of the code. Describes what was observed. Sometimes this is called the observation 'name'. |
subject_display | String | The display of the subject. The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. |
subject_reference | String | The reference of the subject. The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. |
subject_identifier_value | String | The value of the subject-identifier. The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. |
subject_type | String | The subject-type of the subject-type. The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. |
focus_display | String | The display of the focus. The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. |
focus_reference | String | The reference of the focus. The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. |
focus_identifier_value | String | The value of the focus-identifier. The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. |
focus_type | String | The focus-type of the focus-type. The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. |
encounter_display | String | The display of the encounter. The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. |
encounter_reference | String | The reference of the encounter. The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. |
encounter_identifier_value | String | The value of the encounter-identifier. The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. |
encounter_type | String | The encounter-type of the encounter-type. The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. |
effective_x_ | Datetime | The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. |
issued | String | The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. |
performer_display | String | The display of the performer. Who was responsible for asserting the observed value as 'true'. |
performer_reference | String | The reference of the performer. Who was responsible for asserting the observed value as 'true'. |
performer_identifier_value | String | The value of the performer-identifier. Who was responsible for asserting the observed value as 'true'. |
performer_type | String | The performer-type of the performer-type. Who was responsible for asserting the observed value as 'true'. |
value_x_value | Decimal | The value of the value[x]. The information determined as a result of making the observation, if the information has a simple value. |
value_x_unit | String | The unit of the value[x]. The information determined as a result of making the observation, if the information has a simple value. |
value_x_system | String | The system of the value[x]. The information determined as a result of making the observation, if the information has a simple value. |
value_x_comparator | String | The value[x]-comparator of the value[x]-comparator. The information determined as a result of making the observation, if the information has a simple value. |
value_x_code | String | The value[x]-code of the value[x]-code. The information determined as a result of making the observation, if the information has a simple value. |
dataAbsentReason_coding | String | The coding of the dataAbsentReason. Provides a reason why the expected value in the element Observation.value[x] is missing. |
dataAbsentReason_text | String | The text of the dataAbsentReason. Provides a reason why the expected value in the element Observation.value[x] is missing. |
interpretation_coding | String | The coding of the interpretation. A categorical assessment of an observation value. For example, high, low, normal. |
interpretation_text | String | The text of the interpretation. A categorical assessment of an observation value. For example, high, low, normal. |
note | String | Comments about the observation or the results. |
bodySite_coding | String | The coding of the bodySite. Indicates the site on the subject's body where the observation was made (i.e. the target site). |
bodySite_text | String | The text of the bodySite. Indicates the site on the subject's body where the observation was made (i.e. the target site). |
method_coding | String | The coding of the method. Indicates the mechanism used to perform the observation. |
method_text | String | The text of the method. Indicates the mechanism used to perform the observation. |
specimen_display | String | The display of the specimen. The specimen that was used when this observation was made. |
specimen_reference | String | The reference of the specimen. The specimen that was used when this observation was made. |
specimen_identifier_value | String | The value of the specimen-identifier. The specimen that was used when this observation was made. |
specimen_type | String | The specimen-type of the specimen-type. The specimen that was used when this observation was made. |
device_display | String | The display of the device. The device used to generate the observation data. |
device_reference | String | The reference of the device. The device used to generate the observation data. |
device_identifier_value | String | The value of the device-identifier. The device used to generate the observation data. |
device_type | String | The device-type of the device-type. The device used to generate the observation data. |
referenceRange_id | String | The referenceRange-id of the referenceRange-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
referenceRange_extension | String | The referenceRange-extension of the referenceRange-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
referenceRange_modifierExtension | String | The referenceRange-modifierExtension of the referenceRange-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
referenceRange_low_value | Decimal | The value of the referenceRange-low. The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). |
referenceRange_low_unit | String | The unit of the referenceRange-low. The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). |
referenceRange_low_system | String | The system of the referenceRange-low. The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). |
referenceRange_low_comparator | String | The referenceRange-low-comparator of the referenceRange-low-comparator. The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). |
referenceRange_low_code | String | The referenceRange-low-code of the referenceRange-low-code. The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). |
referenceRange_high_value | Decimal | The value of the referenceRange-high. The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). |
referenceRange_high_unit | String | The unit of the referenceRange-high. The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). |
referenceRange_high_system | String | The system of the referenceRange-high. The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). |
referenceRange_high_comparator | String | The referenceRange-high-comparator of the referenceRange-high-comparator. The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). |
referenceRange_high_code | String | The referenceRange-high-code of the referenceRange-high-code. The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). |
referenceRange_type_coding | String | The coding of the referenceRange-type. Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. |
referenceRange_type_text | String | The text of the referenceRange-type. Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. |
referenceRange_appliesTo_coding | String | The coding of the referenceRange-appliesTo. Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. |
referenceRange_appliesTo_text | String | The text of the referenceRange-appliesTo. Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. |
referenceRange_age_low | String | The referenceRange-age-low of the referenceRange-age-low. The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. |
referenceRange_age_high | String | The referenceRange-age-high of the referenceRange-age-high. The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. |
referenceRange_text | String | The referenceRange-text of the referenceRange-text. Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of 'Negative' or a list or table of 'normals'. |
hasMember_display | String | The display of the hasMember. This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. |
hasMember_reference | String | The reference of the hasMember. This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. |
hasMember_identifier_value | String | The value of the hasMember-identifier. This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. |
hasMember_type | String | The hasMember-type of the hasMember-type. This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. |
derivedFrom_display | String | The display of the derivedFrom. The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. |
derivedFrom_reference | String | The reference of the derivedFrom. The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. |
derivedFrom_identifier_value | String | The value of the derivedFrom-identifier. The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. |
derivedFrom_type | String | The derivedFrom-type of the derivedFrom-type. The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. |
component_id | String | The component-id of the component-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
component_extension | String | The component-extension of the component-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
component_modifierExtension | String | The component-modifierExtension of the component-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
component_code_coding | String | The coding of the component-code. Describes what was observed. Sometimes this is called the observation 'code'. |
component_code_text | String | The text of the component-code. Describes what was observed. Sometimes this is called the observation 'code'. |
component_value_x_value | Decimal | The value of the component-value[x]. The information determined as a result of making the observation, if the information has a simple value. |
component_value_x_unit | String | The unit of the component-value[x]. The information determined as a result of making the observation, if the information has a simple value. |
component_value_x_system | String | The system of the component-value[x]. The information determined as a result of making the observation, if the information has a simple value. |
component_value_x_comparator | String | The component-value[x]-comparator of the component-value[x]-comparator. The information determined as a result of making the observation, if the information has a simple value. |
component_value_x_code | String | The component-value[x]-code of the component-value[x]-code. The information determined as a result of making the observation, if the information has a simple value. |
component_dataAbsentReason_coding | String | The coding of the component-dataAbsentReason. Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
component_dataAbsentReason_text | String | The text of the component-dataAbsentReason. Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
component_interpretation_coding | String | The coding of the component-interpretation. A categorical assessment of an observation value. For example, high, low, normal. |
component_interpretation_text | String | The text of the component-interpretation. A categorical assessment of an observation value. For example, high, low, normal. |
SP_combo_data_absent_reason_start | String | The SP_combo_data_absent_reason_start search parameter. |
SP_code_value_quantity | String | The SP_code_value_quantity search parameter. |
SP_combo_value_concept_end | String | The SP_combo_value_concept_end search parameter. |
SP_based_on | String | The SP_based_on search parameter. |
SP_combo_code_end | String | The SP_combo_code_end search parameter. |
SP_combo_code_value_quantity | String | The SP_combo_code_value_quantity search parameter. |
SP_combo_value_quantity | String | The SP_combo_value_quantity search parameter. |
SP_combo_code_start | String | The SP_combo_code_start search parameter. |
SP_value_concept_start | String | The SP_value_concept_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_code_value_concept | String | The SP_code_value_concept search parameter. |
SP_combo_value_concept_start | String | The SP_combo_value_concept_start search parameter. |
SP_performer | String | The SP_performer search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_value_concept_end | String | The SP_value_concept_end search parameter. |
SP_component_code_end | String | The SP_component_code_end search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_part_of | String | The SP_part_of search parameter. |
SP_method_end | String | The SP_method_end search parameter. |
SP_value_date | String | The SP_value_date search parameter. |
SP_dna_variant | String | The SP_dna_variant search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_gene_amino_acid_change | String | The SP_gene_amino_acid_change search parameter. |
SP_amino_acid_change | String | The SP_amino_acid_change search parameter. |
SP_component_code_start | String | The SP_component_code_start search parameter. |
SP_component_value_quantity | String | The SP_component_value_quantity search parameter. |
SP_component_data_absent_reason_end | String | The SP_component_data_absent_reason_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_gene_identifier_end | String | The SP_gene_identifier_end search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_gene_identifier_start | String | The SP_gene_identifier_start search parameter. |
SP_component_data_absent_reason_start | String | The SP_component_data_absent_reason_start search parameter. |
SP_derived_from | String | The SP_derived_from search parameter. |
SP_value_string | String | The SP_value_string search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_combo_code_value_concept | String | The SP_combo_code_value_concept search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_text | String | The SP_text search parameter. |
SP_code_value_string | String | The SP_code_value_string search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_component_value_concept_end | String | The SP_component_value_concept_end search parameter. |
SP_component_code_value_concept | String | The SP_component_code_value_concept search parameter. |
SP_data_absent_reason_end | String | The SP_data_absent_reason_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_content | String | The SP_content search parameter. |
SP_method_start | String | The SP_method_start search parameter. |
SP_specimen | String | The SP_specimen search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_component_code_value_quantity | String | The SP_component_code_value_quantity search parameter. |
SP_focus | String | The SP_focus search parameter. |
SP_component_value_concept_start | String | The SP_component_value_concept_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_combo_data_absent_reason_end | String | The SP_combo_data_absent_reason_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_device | String | The SP_device search parameter. |
SP_has_member | String | The SP_has_member search parameter. |
SP_value_quantity | String | The SP_value_quantity search parameter. |
SP_date | String | The SP_date search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_data_absent_reason_start | String | The SP_data_absent_reason_start search parameter. |
SP_code_value_date | String | The SP_code_value_date search parameter. |
SP_gene_dnavariant | String | The SP_gene_dnavariant search parameter. |
ObservationDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
category_coding | String | The coding of the category. A code that classifies the general type of observation. |
category_text | String | The text of the category. A code that classifies the general type of observation. |
code_coding | String | The coding of the code. Describes what will be observed. Sometimes this is called the observation 'name'. |
code_text | String | The text of the code. Describes what will be observed. Sometimes this is called the observation 'name'. |
identifier_value | String | The value of the identifier. A unique identifier assigned to this ObservationDefinition artifact. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this ObservationDefinition artifact. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this ObservationDefinition artifact. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this ObservationDefinition artifact. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this ObservationDefinition artifact. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this ObservationDefinition artifact. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this ObservationDefinition artifact. |
permittedDataType | String | The data types allowed for the value element of the instance observations conforming to this ObservationDefinition. |
multipleResultsAllowed | Bool | Multiple results allowed for observations conforming to this ObservationDefinition. |
method_coding | String | The coding of the method. The method or technique used to perform the observation. |
method_text | String | The text of the method. The method or technique used to perform the observation. |
preferredReportName | String | The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition. |
quantitativeDetails_id | String | The quantitativeDetails-id of the quantitativeDetails-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
quantitativeDetails_extension | String | The quantitativeDetails-extension of the quantitativeDetails-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
quantitativeDetails_modifierExtension | String | The quantitativeDetails-modifierExtension of the quantitativeDetails-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
quantitativeDetails_customaryUnit_coding | String | The coding of the quantitativeDetails-customaryUnit. Customary unit used to report quantitative results of observations conforming to this ObservationDefinition. |
quantitativeDetails_customaryUnit_text | String | The text of the quantitativeDetails-customaryUnit. Customary unit used to report quantitative results of observations conforming to this ObservationDefinition. |
quantitativeDetails_unit_coding | String | The coding of the quantitativeDetails-unit. SI unit used to report quantitative results of observations conforming to this ObservationDefinition. |
quantitativeDetails_unit_text | String | The text of the quantitativeDetails-unit. SI unit used to report quantitative results of observations conforming to this ObservationDefinition. |
quantitativeDetails_conversionFactor | Decimal | The quantitativeDetails-conversionFactor of the quantitativeDetails-conversionFactor. Factor for converting value expressed with SI unit to value expressed with customary unit. |
quantitativeDetails_decimalPrecision | Int | The quantitativeDetails-decimalPrecision of the quantitativeDetails-decimalPrecision. Number of digits after decimal separator when the results of such observations are of type Quantity. |
qualifiedInterval_id | String | The qualifiedInterval-id of the qualifiedInterval-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
qualifiedInterval_extension | String | The qualifiedInterval-extension of the qualifiedInterval-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
qualifiedInterval_modifierExtension | String | The qualifiedInterval-modifierExtension of the qualifiedInterval-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
qualifiedInterval_category | String | The qualifiedInterval-category of the qualifiedInterval-category. The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition. |
qualifiedInterval_range_low | String | The qualifiedInterval-range-low of the qualifiedInterval-range-low. The low and high values determining the interval. There may be only one of the two. |
qualifiedInterval_range_high | String | The qualifiedInterval-range-high of the qualifiedInterval-range-high. The low and high values determining the interval. There may be only one of the two. |
qualifiedInterval_context_coding | String | The coding of the qualifiedInterval-context. Codes to indicate the health context the range applies to. For example, the normal or therapeutic range. |
qualifiedInterval_context_text | String | The text of the qualifiedInterval-context. Codes to indicate the health context the range applies to. For example, the normal or therapeutic range. |
qualifiedInterval_appliesTo_coding | String | The coding of the qualifiedInterval-appliesTo. Codes to indicate the target population this reference range applies to. |
qualifiedInterval_appliesTo_text | String | The text of the qualifiedInterval-appliesTo. Codes to indicate the target population this reference range applies to. |
qualifiedInterval_gender | String | The qualifiedInterval-gender of the qualifiedInterval-gender. Sex of the population the range applies to. |
qualifiedInterval_age_low | String | The qualifiedInterval-age-low of the qualifiedInterval-age-low. The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. |
qualifiedInterval_age_high | String | The qualifiedInterval-age-high of the qualifiedInterval-age-high. The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. |
qualifiedInterval_gestationalAge_low | String | The qualifiedInterval-gestationalAge-low of the qualifiedInterval-gestationalAge-low. The gestational age to which this reference range is applicable, in the context of pregnancy. |
qualifiedInterval_gestationalAge_high | String | The qualifiedInterval-gestationalAge-high of the qualifiedInterval-gestationalAge-high. The gestational age to which this reference range is applicable, in the context of pregnancy. |
qualifiedInterval_condition | String | The qualifiedInterval-condition of the qualifiedInterval-condition. Text based condition for which the reference range is valid. |
validCodedValueSet_display | String | The display of the validCodedValueSet. The set of valid coded results for the observations conforming to this ObservationDefinition. |
validCodedValueSet_reference | String | The reference of the validCodedValueSet. The set of valid coded results for the observations conforming to this ObservationDefinition. |
validCodedValueSet_identifier_value | String | The value of the validCodedValueSet-identifier. The set of valid coded results for the observations conforming to this ObservationDefinition. |
validCodedValueSet_type | String | The validCodedValueSet-type of the validCodedValueSet-type. The set of valid coded results for the observations conforming to this ObservationDefinition. |
normalCodedValueSet_display | String | The display of the normalCodedValueSet. The set of normal coded results for the observations conforming to this ObservationDefinition. |
normalCodedValueSet_reference | String | The reference of the normalCodedValueSet. The set of normal coded results for the observations conforming to this ObservationDefinition. |
normalCodedValueSet_identifier_value | String | The value of the normalCodedValueSet-identifier. The set of normal coded results for the observations conforming to this ObservationDefinition. |
normalCodedValueSet_type | String | The normalCodedValueSet-type of the normalCodedValueSet-type. The set of normal coded results for the observations conforming to this ObservationDefinition. |
abnormalCodedValueSet_display | String | The display of the abnormalCodedValueSet. The set of abnormal coded results for the observation conforming to this ObservationDefinition. |
abnormalCodedValueSet_reference | String | The reference of the abnormalCodedValueSet. The set of abnormal coded results for the observation conforming to this ObservationDefinition. |
abnormalCodedValueSet_identifier_value | String | The value of the abnormalCodedValueSet-identifier. The set of abnormal coded results for the observation conforming to this ObservationDefinition. |
abnormalCodedValueSet_type | String | The abnormalCodedValueSet-type of the abnormalCodedValueSet-type. The set of abnormal coded results for the observation conforming to this ObservationDefinition. |
criticalCodedValueSet_display | String | The display of the criticalCodedValueSet. The set of critical coded results for the observation conforming to this ObservationDefinition. |
criticalCodedValueSet_reference | String | The reference of the criticalCodedValueSet. The set of critical coded results for the observation conforming to this ObservationDefinition. |
criticalCodedValueSet_identifier_value | String | The value of the criticalCodedValueSet-identifier. The set of critical coded results for the observation conforming to this ObservationDefinition. |
criticalCodedValueSet_type | String | The criticalCodedValueSet-type of the criticalCodedValueSet-type. The set of critical coded results for the observation conforming to this ObservationDefinition. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
Organization view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifier for the organization that is used to identify the organization across multiple disparate systems. |
identifier_use | String | The identifier-use of the identifier-use. Identifier for the organization that is used to identify the organization across multiple disparate systems. |
identifier_type_coding | String | The coding of the identifier-type. Identifier for the organization that is used to identify the organization across multiple disparate systems. |
identifier_type_text | String | The text of the identifier-type. Identifier for the organization that is used to identify the organization across multiple disparate systems. |
identifier_system | String | The identifier-system of the identifier-system. Identifier for the organization that is used to identify the organization across multiple disparate systems. |
identifier_period_start | String | The start of the identifier-period. Identifier for the organization that is used to identify the organization across multiple disparate systems. |
identifier_period_end | String | The end of the identifier-period. Identifier for the organization that is used to identify the organization across multiple disparate systems. |
active | Bool | Whether the organization's record is still in active use. |
type_coding | String | The coding of the type. The kind(s) of organization that this is. |
type_text | String | The text of the type. The kind(s) of organization that this is. |
name | String | A name associated with the organization. |
alias | String | A list of alternate names that the organization is known as, or was known as in the past. |
telecom_value | String | The value of the telecom. A contact detail for the organization. |
telecom_system | String | The telecom-system of the telecom-system. A contact detail for the organization. |
telecom_use | String | The telecom-use of the telecom-use. A contact detail for the organization. |
telecom_rank | String | The telecom-rank of the telecom-rank. A contact detail for the organization. |
telecom_period_start | String | The start of the telecom-period. A contact detail for the organization. |
telecom_period_end | String | The end of the telecom-period. A contact detail for the organization. |
address_text | String | The text of the address. An address for the organization. |
address_line | String | The line of the address. An address for the organization. |
address_city | String | The city of the address. An address for the organization. |
address_district | String | The district of the address. An address for the organization. |
address_state | String | The state of the address. An address for the organization. |
address_postalCode | String | The postalCode of the address. An address for the organization. |
address_country | String | The country of the address. An address for the organization. |
address_type | String | The address-type of the address-type. An address for the organization. |
address_period_start | String | The start of the address-period. An address for the organization. |
address_period_end | String | The end of the address-period. An address for the organization. |
address_use | String | The address-use of the address-use. An address for the organization. |
partOf_display | String | The display of the partOf. The organization of which this organization forms a part. |
partOf_reference | String | The reference of the partOf. The organization of which this organization forms a part. |
partOf_identifier_value | String | The value of the partOf-identifier. The organization of which this organization forms a part. |
partOf_type | String | The partOf-type of the partOf-type. The organization of which this organization forms a part. |
contact_id | String | The contact-id of the contact-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
contact_extension | String | The contact-extension of the contact-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
contact_modifierExtension | String | The contact-modifierExtension of the contact-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
contact_purpose_coding | String | The coding of the contact-purpose. Indicates a purpose for which the contact can be reached. |
contact_purpose_text | String | The text of the contact-purpose. Indicates a purpose for which the contact can be reached. |
contact_name_use | String | The use of the contact-name. A name associated with the contact. |
contact_name_family | String | The family of the contact-name. A name associated with the contact. |
contact_name_given | String | The given of the contact-name. A name associated with the contact. |
contact_name_prefix | String | The prefix of the contact-name. A name associated with the contact. |
contact_name_suffix | String | The suffix of the contact-name. A name associated with the contact. |
contact_name_period_start | Datetime | The start of the contact-name-period. A name associated with the contact. |
contact_name_period_end | Datetime | The end of the contact-name-period. A name associated with the contact. |
contact_telecom_value | String | The value of the contact-telecom. A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
contact_telecom_system | String | The contact-telecom-system of the contact-telecom-system. A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
contact_telecom_use | String | The contact-telecom-use of the contact-telecom-use. A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
contact_telecom_rank | String | The contact-telecom-rank of the contact-telecom-rank. A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
contact_telecom_period_start | String | The start of the contact-telecom-period. A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
contact_telecom_period_end | String | The end of the contact-telecom-period. A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
contact_address_text | String | The text of the contact-address. Visiting or postal addresses for the contact. |
contact_address_line | String | The line of the contact-address. Visiting or postal addresses for the contact. |
contact_address_city | String | The city of the contact-address. Visiting or postal addresses for the contact. |
contact_address_district | String | The district of the contact-address. Visiting or postal addresses for the contact. |
contact_address_state | String | The state of the contact-address. Visiting or postal addresses for the contact. |
contact_address_postalCode | String | The postalCode of the contact-address. Visiting or postal addresses for the contact. |
contact_address_country | String | The country of the contact-address. Visiting or postal addresses for the contact. |
contact_address_type | String | The contact-address-type of the contact-address-type. Visiting or postal addresses for the contact. |
contact_address_period_start | Datetime | The start of the contact-address-period. Visiting or postal addresses for the contact. |
contact_address_period_end | Datetime | The end of the contact-address-period. Visiting or postal addresses for the contact. |
contact_address_use | String | The contact-address-use of the contact-address-use. Visiting or postal addresses for the contact. |
endpoint_display | String | The display of the endpoint. Technical endpoints providing access to services operated for the organization. |
endpoint_reference | String | The reference of the endpoint. Technical endpoints providing access to services operated for the organization. |
endpoint_identifier_value | String | The value of the endpoint-identifier. Technical endpoints providing access to services operated for the organization. |
endpoint_type | String | The endpoint-type of the endpoint-type. Technical endpoints providing access to services operated for the organization. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_address | String | The SP_address search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_endpoint | String | The SP_endpoint search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_partof | String | The SP_partof search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_phonetic | String | The SP_phonetic search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
OrganizationAffiliation view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers that are specific to this role. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers that are specific to this role. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers that are specific to this role. |
identifier_type_text | String | The text of the identifier-type. Business identifiers that are specific to this role. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers that are specific to this role. |
identifier_period_start | String | The start of the identifier-period. Business identifiers that are specific to this role. |
identifier_period_end | String | The end of the identifier-period. Business identifiers that are specific to this role. |
active | Bool | Whether this organization affiliation record is in active use. |
period_start | Datetime | The start of the period. The period during which the participatingOrganization is affiliated with the primary organization. |
period_end | Datetime | The end of the period. The period during which the participatingOrganization is affiliated with the primary organization. |
organization_display | String | The display of the organization. Organization where the role is available (primary organization/has members). |
organization_reference | String | The reference of the organization. Organization where the role is available (primary organization/has members). |
organization_identifier_value | String | The value of the organization-identifier. Organization where the role is available (primary organization/has members). |
organization_type | String | The organization-type of the organization-type. Organization where the role is available (primary organization/has members). |
participatingOrganization_display | String | The display of the participatingOrganization. The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of). |
participatingOrganization_reference | String | The reference of the participatingOrganization. The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of). |
participatingOrganization_identifier_value | String | The value of the participatingOrganization-identifier. The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of). |
participatingOrganization_type | String | The participatingOrganization-type of the participatingOrganization-type. The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of). |
network_display | String | The display of the network. Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined). |
network_reference | String | The reference of the network. Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined). |
network_identifier_value | String | The value of the network-identifier. Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined). |
network_type | String | The network-type of the network-type. Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined). |
code_coding | String | The coding of the code. Definition of the role the participatingOrganization plays in the association. |
code_text | String | The text of the code. Definition of the role the participatingOrganization plays in the association. |
specialty_coding | String | The coding of the specialty. Specific specialty of the participatingOrganization in the context of the role. |
specialty_text | String | The text of the specialty. Specific specialty of the participatingOrganization in the context of the role. |
location_display | String | The display of the location. The location(s) at which the role occurs. |
location_reference | String | The reference of the location. The location(s) at which the role occurs. |
location_identifier_value | String | The value of the location-identifier. The location(s) at which the role occurs. |
location_type | String | The location-type of the location-type. The location(s) at which the role occurs. |
healthcareService_display | String | The display of the healthcareService. Healthcare services provided through the role. |
healthcareService_reference | String | The reference of the healthcareService. Healthcare services provided through the role. |
healthcareService_identifier_value | String | The value of the healthcareService-identifier. Healthcare services provided through the role. |
healthcareService_type | String | The healthcareService-type of the healthcareService-type. Healthcare services provided through the role. |
telecom_value | String | The value of the telecom. Contact details at the participatingOrganization relevant to this Affiliation. |
telecom_system | String | The telecom-system of the telecom-system. Contact details at the participatingOrganization relevant to this Affiliation. |
telecom_use | String | The telecom-use of the telecom-use. Contact details at the participatingOrganization relevant to this Affiliation. |
telecom_rank | String | The telecom-rank of the telecom-rank. Contact details at the participatingOrganization relevant to this Affiliation. |
telecom_period_start | String | The start of the telecom-period. Contact details at the participatingOrganization relevant to this Affiliation. |
telecom_period_end | String | The end of the telecom-period. Contact details at the participatingOrganization relevant to this Affiliation. |
endpoint_display | String | The display of the endpoint. Technical endpoints providing access to services operated for this role. |
endpoint_reference | String | The reference of the endpoint. Technical endpoints providing access to services operated for this role. |
endpoint_identifier_value | String | The value of the endpoint-identifier. Technical endpoints providing access to services operated for this role. |
endpoint_type | String | The endpoint-type of the endpoint-type. Technical endpoints providing access to services operated for this role. |
SP_location | String | The SP_location search parameter. |
SP_source | String | The SP_source search parameter. |
SP_email_end | String | The SP_email_end search parameter. |
SP_phone_start | String | The SP_phone_start search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_primary_organization | String | The SP_primary_organization search parameter. |
SP_telecom_end | String | The SP_telecom_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_role_start | String | The SP_role_start search parameter. |
SP_specialty_end | String | The SP_specialty_end search parameter. |
SP_endpoint | String | The SP_endpoint search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_telecom_start | String | The SP_telecom_start search parameter. |
SP_email_start | String | The SP_email_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_participating_organization | String | The SP_participating_organization search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_specialty_start | String | The SP_specialty_start search parameter. |
SP_role_end | String | The SP_role_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_phone_end | String | The SP_phone_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_date | String | The SP_date search parameter. |
SP_service | String | The SP_service search parameter. |
SP_network | String | The SP_network search parameter. |
PackagedProductDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Unique identifier. |
identifier_use | String | The identifier-use of the identifier-use. Unique identifier. |
identifier_type_coding | String | The coding of the identifier-type. Unique identifier. |
identifier_type_text | String | The text of the identifier-type. Unique identifier. |
identifier_system | String | The identifier-system of the identifier-system. Unique identifier. |
identifier_period_start | String | The start of the identifier-period. Unique identifier. |
identifier_period_end | String | The end of the identifier-period. Unique identifier. |
name | String | A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc. |
type_coding | String | The coding of the type. A high level category e.g. medicinal product, raw material, shipping/transport container, etc. |
type_text | String | The text of the type. A high level category e.g. medicinal product, raw material, shipping/transport container, etc. |
packageFor_display | String | The display of the packageFor. The product that this is a pack for. |
packageFor_reference | String | The reference of the packageFor. The product that this is a pack for. |
packageFor_identifier_value | String | The value of the packageFor-identifier. The product that this is a pack for. |
packageFor_type | String | The packageFor-type of the packageFor-type. The product that this is a pack for. |
status_coding | String | The coding of the status. The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status. |
status_text | String | The text of the status. The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status. |
statusDate | Datetime | The date at which the given status became applicable. |
containedItemQuantity_value | String | The value of the containedItemQuantity. A total of the amount of items in the package, per item type. This can be considered as the pack size. This attribute differs from containedItem.amount in that it can give a single aggregated count of all tablet types in a pack, even when these are different manufactured items. For example a pill pack of 21 tablets plus 7 sugar tablets, can be denoted here as '28 tablets'. This attribute is repeatable so that the different item types in one pack type can be counted (e.g. a count of vials and count of syringes). Each repeat must have different units, so that it is clear what the different sets of counted items are, and it is not intended to allow different counts of similar items (e.g. not '2 tubes and 3 tubes'). Repeats are not to be used to represent different pack sizes (e.g. 20 pack vs. 50 pack) - which would be different instances of this resource. |
containedItemQuantity_unit | String | The unit of the containedItemQuantity. A total of the amount of items in the package, per item type. This can be considered as the pack size. This attribute differs from containedItem.amount in that it can give a single aggregated count of all tablet types in a pack, even when these are different manufactured items. For example a pill pack of 21 tablets plus 7 sugar tablets, can be denoted here as '28 tablets'. This attribute is repeatable so that the different item types in one pack type can be counted (e.g. a count of vials and count of syringes). Each repeat must have different units, so that it is clear what the different sets of counted items are, and it is not intended to allow different counts of similar items (e.g. not '2 tubes and 3 tubes'). Repeats are not to be used to represent different pack sizes (e.g. 20 pack vs. 50 pack) - which would be different instances of this resource. |
containedItemQuantity_system | String | The system of the containedItemQuantity. A total of the amount of items in the package, per item type. This can be considered as the pack size. This attribute differs from containedItem.amount in that it can give a single aggregated count of all tablet types in a pack, even when these are different manufactured items. For example a pill pack of 21 tablets plus 7 sugar tablets, can be denoted here as '28 tablets'. This attribute is repeatable so that the different item types in one pack type can be counted (e.g. a count of vials and count of syringes). Each repeat must have different units, so that it is clear what the different sets of counted items are, and it is not intended to allow different counts of similar items (e.g. not '2 tubes and 3 tubes'). Repeats are not to be used to represent different pack sizes (e.g. 20 pack vs. 50 pack) - which would be different instances of this resource. |
containedItemQuantity_comparator | String | The containedItemQuantity-comparator of the containedItemQuantity-comparator. A total of the amount of items in the package, per item type. This can be considered as the pack size. This attribute differs from containedItem.amount in that it can give a single aggregated count of all tablet types in a pack, even when these are different manufactured items. For example a pill pack of 21 tablets plus 7 sugar tablets, can be denoted here as '28 tablets'. This attribute is repeatable so that the different item types in one pack type can be counted (e.g. a count of vials and count of syringes). Each repeat must have different units, so that it is clear what the different sets of counted items are, and it is not intended to allow different counts of similar items (e.g. not '2 tubes and 3 tubes'). Repeats are not to be used to represent different pack sizes (e.g. 20 pack vs. 50 pack) - which would be different instances of this resource. |
containedItemQuantity_code | String | The containedItemQuantity-code of the containedItemQuantity-code. A total of the amount of items in the package, per item type. This can be considered as the pack size. This attribute differs from containedItem.amount in that it can give a single aggregated count of all tablet types in a pack, even when these are different manufactured items. For example a pill pack of 21 tablets plus 7 sugar tablets, can be denoted here as '28 tablets'. This attribute is repeatable so that the different item types in one pack type can be counted (e.g. a count of vials and count of syringes). Each repeat must have different units, so that it is clear what the different sets of counted items are, and it is not intended to allow different counts of similar items (e.g. not '2 tubes and 3 tubes'). Repeats are not to be used to represent different pack sizes (e.g. 20 pack vs. 50 pack) - which would be different instances of this resource. |
description | String | Textual description. Note that this is not the name of the package or product. |
legalStatusOfSupply_id | String | The legalStatusOfSupply-id of the legalStatusOfSupply-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
legalStatusOfSupply_extension | String | The legalStatusOfSupply-extension of the legalStatusOfSupply-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
legalStatusOfSupply_modifierExtension | String | The legalStatusOfSupply-modifierExtension of the legalStatusOfSupply-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
legalStatusOfSupply_code_coding | String | The coding of the legalStatusOfSupply-code. The actual status of supply. In what situation this package type may be supplied for use. |
legalStatusOfSupply_code_text | String | The text of the legalStatusOfSupply-code. The actual status of supply. In what situation this package type may be supplied for use. |
legalStatusOfSupply_jurisdiction_coding | String | The coding of the legalStatusOfSupply-jurisdiction. The place where the legal status of supply applies. When not specified, this indicates it is unknown in this context. |
legalStatusOfSupply_jurisdiction_text | String | The text of the legalStatusOfSupply-jurisdiction. The place where the legal status of supply applies. When not specified, this indicates it is unknown in this context. |
marketingStatus | String | Marketing information. |
characteristic_coding | String | The coding of the characteristic. Allows the key features to be recorded, such as 'hospital pack', 'nurse prescribable', 'calendar pack'. |
characteristic_text | String | The text of the characteristic. Allows the key features to be recorded, such as 'hospital pack', 'nurse prescribable', 'calendar pack'. |
copackagedIndicator | Bool | States whether a drug product is supplied with another item such as a diluent or adjuvant. |
manufacturer_display | String | The display of the manufacturer. Manufacturer of this package type. When there are multiple it means these are all possible manufacturers. |
manufacturer_reference | String | The reference of the manufacturer. Manufacturer of this package type. When there are multiple it means these are all possible manufacturers. |
manufacturer_identifier_value | String | The value of the manufacturer-identifier. Manufacturer of this package type. When there are multiple it means these are all possible manufacturers. |
manufacturer_type | String | The manufacturer-type of the manufacturer-type. Manufacturer of this package type. When there are multiple it means these are all possible manufacturers. |
package_id | String | The package-id of the package-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
package_extension | String | The package-extension of the package-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
package_modifierExtension | String | The package-modifierExtension of the package-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
package_identifier_value | String | The value of the package-identifier. Including possibly Data Carrier Identifier. |
package_identifier_use | String | The package-identifier-use of the package-identifier-use. Including possibly Data Carrier Identifier. |
package_identifier_type_coding | String | The coding of the package-identifier-type. Including possibly Data Carrier Identifier. |
package_identifier_type_text | String | The text of the package-identifier-type. Including possibly Data Carrier Identifier. |
package_identifier_system | String | The package-identifier-system of the package-identifier-system. Including possibly Data Carrier Identifier. |
package_identifier_period_start | String | The start of the package-identifier-period. Including possibly Data Carrier Identifier. |
package_identifier_period_end | String | The end of the package-identifier-period. Including possibly Data Carrier Identifier. |
package_type_coding | String | The coding of the package-type. The physical type of the container of the items. |
package_type_text | String | The text of the package-type. The physical type of the container of the items. |
package_quantity | Int | The package-quantity of the package-quantity. The quantity of this level of packaging in the package that contains it. If specified, the outermost level is always 1. |
package_material_coding | String | The coding of the package-material. Material type of the package item. |
package_material_text | String | The text of the package-material. Material type of the package item. |
package_alternateMaterial_coding | String | The coding of the package-alternateMaterial. A possible alternate material for the packaging. |
package_alternateMaterial_text | String | The text of the package-alternateMaterial. A possible alternate material for the packaging. |
package_shelfLifeStorage | String | The package-shelfLifeStorage of the package-shelfLifeStorage. Shelf Life and storage information. |
package_manufacturer_display | String | The display of the package-manufacturer. Manufacturer of this package Item. When there are multiple it means these are all possible manufacturers. |
package_manufacturer_reference | String | The reference of the package-manufacturer. Manufacturer of this package Item. When there are multiple it means these are all possible manufacturers. |
package_manufacturer_identifier_value | String | The value of the package-manufacturer-identifier. Manufacturer of this package Item. When there are multiple it means these are all possible manufacturers. |
package_manufacturer_type | String | The package-manufacturer-type of the package-manufacturer-type. Manufacturer of this package Item. When there are multiple it means these are all possible manufacturers. |
package_property_id | String | The package-property-id of the package-property-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
package_property_extension | String | The package-property-extension of the package-property-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
package_property_modifierExtension | String | The package-property-modifierExtension of the package-property-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
package_property_type_coding | String | The coding of the package-property-type. A code expressing the type of characteristic. |
package_property_type_text | String | The text of the package-property-type. A code expressing the type of characteristic. |
package_property_value_x_coding | String | The coding of the package-property-value[x]. A value for the characteristic. |
package_property_value_x_text | String | The text of the package-property-value[x]. A value for the characteristic. |
package_containedItem_id | String | The package-containedItem-id of the package-containedItem-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
package_containedItem_extension | String | The package-containedItem-extension of the package-containedItem-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
package_containedItem_modifierExtension | String | The package-containedItem-modifierExtension of the package-containedItem-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
package_containedItem_item_display | String | The display of the package-containedItem-item. The actual item(s) of medication, as manufactured, or a device (typically, but not necessarily, a co-packaged one), or other medically related item (such as food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package. This also allows another whole packaged product to be included, which is solely for the case where a package of other entire packages is wanted - such as a wholesale or distribution pack (for layers within one package, use PackagedProductDefinition.package.package). |
package_containedItem_item_reference | String | The reference of the package-containedItem-item. The actual item(s) of medication, as manufactured, or a device (typically, but not necessarily, a co-packaged one), or other medically related item (such as food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package. This also allows another whole packaged product to be included, which is solely for the case where a package of other entire packages is wanted - such as a wholesale or distribution pack (for layers within one package, use PackagedProductDefinition.package.package). |
package_containedItem_item_identifier_value | String | The value of the package-containedItem-item-identifier. The actual item(s) of medication, as manufactured, or a device (typically, but not necessarily, a co-packaged one), or other medically related item (such as food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package. This also allows another whole packaged product to be included, which is solely for the case where a package of other entire packages is wanted - such as a wholesale or distribution pack (for layers within one package, use PackagedProductDefinition.package.package). |
package_containedItem_item_type | String | The package-containedItem-item-type of the package-containedItem-item-type. The actual item(s) of medication, as manufactured, or a device (typically, but not necessarily, a co-packaged one), or other medically related item (such as food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package. This also allows another whole packaged product to be included, which is solely for the case where a package of other entire packages is wanted - such as a wholesale or distribution pack (for layers within one package, use PackagedProductDefinition.package.package). |
package_containedItem_amount_value | Decimal | The value of the package-containedItem-amount. The number of this type of item within this packaging. |
package_containedItem_amount_unit | String | The unit of the package-containedItem-amount. The number of this type of item within this packaging. |
package_containedItem_amount_system | String | The system of the package-containedItem-amount. The number of this type of item within this packaging. |
package_containedItem_amount_comparator | String | The package-containedItem-amount-comparator of the package-containedItem-amount-comparator. The number of this type of item within this packaging. |
package_containedItem_amount_code | String | The package-containedItem-amount-code of the package-containedItem-amount-code. The number of this type of item within this packaging. |
SP_source | String | The SP_source search parameter. |
SP_medication | String | The SP_medication search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_status_start | String | The SP_status_start search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_package | String | The SP_package search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_contained_item | String | The SP_contained_item search parameter. |
SP_manufactured_item | String | The SP_manufactured_item search parameter. |
SP_status_end | String | The SP_status_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_device | String | The SP_device search parameter. |
SP_package_for | String | The SP_package_for search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_biological | String | The SP_biological search parameter. |
SP_nutrition | String | The SP_nutrition search parameter. |
Patient view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. An identifier for this patient. |
identifier_use | String | The identifier-use of the identifier-use. An identifier for this patient. |
identifier_type_coding | String | The coding of the identifier-type. An identifier for this patient. |
identifier_type_text | String | The text of the identifier-type. An identifier for this patient. |
identifier_system | String | The identifier-system of the identifier-system. An identifier for this patient. |
identifier_period_start | String | The start of the identifier-period. An identifier for this patient. |
identifier_period_end | String | The end of the identifier-period. An identifier for this patient. |
active | Bool | Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. |
name_use | String | The use of the name. A name associated with the individual. |
name_family | String | The family of the name. A name associated with the individual. |
name_given | String | The given of the name. A name associated with the individual. |
name_prefix | String | The prefix of the name. A name associated with the individual. |
name_suffix | String | The suffix of the name. A name associated with the individual. |
name_period_start | String | The start of the name-period. A name associated with the individual. |
name_period_end | String | The end of the name-period. A name associated with the individual. |
telecom_value | String | The value of the telecom. A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. |
telecom_system | String | The telecom-system of the telecom-system. A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. |
telecom_use | String | The telecom-use of the telecom-use. A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. |
telecom_rank | String | The telecom-rank of the telecom-rank. A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. |
telecom_period_start | String | The start of the telecom-period. A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. |
telecom_period_end | String | The end of the telecom-period. A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. |
gender | String | Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. |
birthDate | Date | The date of birth for the individual. |
deceased_x_ | Bool | Indicates if the individual is deceased or not. |
address_text | String | The text of the address. An address for the individual. |
address_line | String | The line of the address. An address for the individual. |
address_city | String | The city of the address. An address for the individual. |
address_district | String | The district of the address. An address for the individual. |
address_state | String | The state of the address. An address for the individual. |
address_postalCode | String | The postalCode of the address. An address for the individual. |
address_country | String | The country of the address. An address for the individual. |
address_type | String | The address-type of the address-type. An address for the individual. |
address_period_start | String | The start of the address-period. An address for the individual. |
address_period_end | String | The end of the address-period. An address for the individual. |
address_use | String | The address-use of the address-use. An address for the individual. |
maritalStatus_coding | String | The coding of the maritalStatus. This field contains a patient's most recent marital (civil) status. |
maritalStatus_text | String | The text of the maritalStatus. This field contains a patient's most recent marital (civil) status. |
multipleBirth_x_ | Bool | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). |
photo_data | String | The data of the photo. Image of the patient. |
photo_url | String | The url of the photo. Image of the patient. |
photo_size | String | The size of the photo. Image of the patient. |
photo_title | String | The title of the photo. Image of the patient. |
photo_creation | String | The creation of the photo. Image of the patient. |
photo_height | String | The height of the photo. Image of the patient. |
photo_width | String | The width of the photo. Image of the patient. |
photo_frames | String | The frames of the photo. Image of the patient. |
photo_duration | String | The duration of the photo. Image of the patient. |
photo_pages | String | The pages of the photo. Image of the patient. |
photo_contentType | String | The photo-contentType of the photo-contentType. Image of the patient. |
photo_language | String | The photo-language of the photo-language. Image of the patient. |
contact_id | String | The contact-id of the contact-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
contact_extension | String | The contact-extension of the contact-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
contact_modifierExtension | String | The contact-modifierExtension of the contact-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
contact_relationship_coding | String | The coding of the contact-relationship. The nature of the relationship between the patient and the contact person. |
contact_relationship_text | String | The text of the contact-relationship. The nature of the relationship between the patient and the contact person. |
contact_name_use | String | The use of the contact-name. A name associated with the contact person. |
contact_name_family | String | The family of the contact-name. A name associated with the contact person. |
contact_name_given | String | The given of the contact-name. A name associated with the contact person. |
contact_name_prefix | String | The prefix of the contact-name. A name associated with the contact person. |
contact_name_suffix | String | The suffix of the contact-name. A name associated with the contact person. |
contact_name_period_start | Datetime | The start of the contact-name-period. A name associated with the contact person. |
contact_name_period_end | Datetime | The end of the contact-name-period. A name associated with the contact person. |
contact_telecom_value | String | The value of the contact-telecom. A contact detail for the person, e.g. a telephone number or an email address. |
contact_telecom_system | String | The contact-telecom-system of the contact-telecom-system. A contact detail for the person, e.g. a telephone number or an email address. |
contact_telecom_use | String | The contact-telecom-use of the contact-telecom-use. A contact detail for the person, e.g. a telephone number or an email address. |
contact_telecom_rank | String | The contact-telecom-rank of the contact-telecom-rank. A contact detail for the person, e.g. a telephone number or an email address. |
contact_telecom_period_start | String | The start of the contact-telecom-period. A contact detail for the person, e.g. a telephone number or an email address. |
contact_telecom_period_end | String | The end of the contact-telecom-period. A contact detail for the person, e.g. a telephone number or an email address. |
contact_address_text | String | The text of the contact-address. Address for the contact person. |
contact_address_line | String | The line of the contact-address. Address for the contact person. |
contact_address_city | String | The city of the contact-address. Address for the contact person. |
contact_address_district | String | The district of the contact-address. Address for the contact person. |
contact_address_state | String | The state of the contact-address. Address for the contact person. |
contact_address_postalCode | String | The postalCode of the contact-address. Address for the contact person. |
contact_address_country | String | The country of the contact-address. Address for the contact person. |
contact_address_type | String | The contact-address-type of the contact-address-type. Address for the contact person. |
contact_address_period_start | Datetime | The start of the contact-address-period. Address for the contact person. |
contact_address_period_end | Datetime | The end of the contact-address-period. Address for the contact person. |
contact_address_use | String | The contact-address-use of the contact-address-use. Address for the contact person. |
contact_gender | String | The contact-gender of the contact-gender. Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. |
contact_organization_display | String | The display of the contact-organization. Organization on behalf of which the contact is acting or for which the contact is working. |
contact_organization_reference | String | The reference of the contact-organization. Organization on behalf of which the contact is acting or for which the contact is working. |
contact_organization_identifier_value | String | The value of the contact-organization-identifier. Organization on behalf of which the contact is acting or for which the contact is working. |
contact_organization_type | String | The contact-organization-type of the contact-organization-type. Organization on behalf of which the contact is acting or for which the contact is working. |
contact_period_start | Datetime | The start of the contact-period. The period during which this contact person or organization is valid to be contacted relating to this patient. |
contact_period_end | Datetime | The end of the contact-period. The period during which this contact person or organization is valid to be contacted relating to this patient. |
communication_id | String | The communication-id of the communication-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
communication_extension | String | The communication-extension of the communication-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
communication_modifierExtension | String | The communication-modifierExtension of the communication-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
communication_language_coding | String | The coding of the communication-language. The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. 'en' for English, or 'en-US' for American English versus 'en-EN' for England English. |
communication_language_text | String | The text of the communication-language. The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. 'en' for English, or 'en-US' for American English versus 'en-EN' for England English. |
communication_preferred | Bool | The communication-preferred of the communication-preferred. Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). |
generalPractitioner_display | String | The display of the generalPractitioner. Patient's nominated care provider. |
generalPractitioner_reference | String | The reference of the generalPractitioner. Patient's nominated care provider. |
generalPractitioner_identifier_value | String | The value of the generalPractitioner-identifier. Patient's nominated care provider. |
generalPractitioner_type | String | The generalPractitioner-type of the generalPractitioner-type. Patient's nominated care provider. |
managingOrganization_display | String | The display of the managingOrganization. Organization that is the custodian of the patient record. |
managingOrganization_reference | String | The reference of the managingOrganization. Organization that is the custodian of the patient record. |
managingOrganization_identifier_value | String | The value of the managingOrganization-identifier. Organization that is the custodian of the patient record. |
managingOrganization_type | String | The managingOrganization-type of the managingOrganization-type. Organization that is the custodian of the patient record. |
link_id | String | The link-id of the link-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
link_extension | String | The link-extension of the link-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
link_modifierExtension | String | The link-modifierExtension of the link-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
link_other_display | String | The display of the link-other. The other patient resource that the link refers to. |
link_other_reference | String | The reference of the link-other. The other patient resource that the link refers to. |
link_other_identifier_value | String | The value of the link-other-identifier. The other patient resource that the link refers to. |
link_other_type | String | The link-other-type of the link-other-type. The other patient resource that the link refers to. |
link_type | String | The link-type of the link-type. The type of link between this patient resource and another patient resource. |
SP_deceased_start | String | The SP_deceased_start search parameter. |
SP_email_start | String | The SP_email_start search parameter. |
SP_age | String | The SP_age search parameter. |
SP_given | String | The SP_given search parameter. |
SP_link | String | The SP_link search parameter. |
SP_family | String | The SP_family search parameter. |
SP_phone_start | String | The SP_phone_start search parameter. |
SP_name | String | The SP_name search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_general_practitioner | String | The SP_general_practitioner search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_telecom_start | String | The SP_telecom_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_text | String | The SP_text search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_deceased_end | String | The SP_deceased_end search parameter. |
SP_mothersmaidenname | String | The SP_mothersmaidenname search parameter. |
SP_telecom_end | String | The SP_telecom_end search parameter. |
SP_phone_end | String | The SP_phone_end search parameter. |
SP_birthorderboolean | String | The SP_birthorderboolean search parameter. |
SP_source | String | The SP_source search parameter. |
SP_organization | String | The SP_organization search parameter. |
SP_content | String | The SP_content search parameter. |
SP_email_end | String | The SP_email_end search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_address | String | The SP_address search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_death_date | String | The SP_death_date search parameter. |
SP_phonetic | String | The SP_phonetic search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
PaymentNotice view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique identifier assigned to this payment notice. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this payment notice. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this payment notice. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this payment notice. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this payment notice. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this payment notice. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this payment notice. |
status | String | The status of the resource instance. |
request_display | String | The display of the request. Reference of resource for which payment is being made. |
request_reference | String | The reference of the request. Reference of resource for which payment is being made. |
request_identifier_value | String | The value of the request-identifier. Reference of resource for which payment is being made. |
request_type | String | The request-type of the request-type. Reference of resource for which payment is being made. |
response_display | String | The display of the response. Reference of response to resource for which payment is being made. |
response_reference | String | The reference of the response. Reference of response to resource for which payment is being made. |
response_identifier_value | String | The value of the response-identifier. Reference of response to resource for which payment is being made. |
response_type | String | The response-type of the response-type. Reference of response to resource for which payment is being made. |
created | Datetime | The date when this resource was created. |
provider_display | String | The display of the provider. The practitioner who is responsible for the services rendered to the patient. |
provider_reference | String | The reference of the provider. The practitioner who is responsible for the services rendered to the patient. |
provider_identifier_value | String | The value of the provider-identifier. The practitioner who is responsible for the services rendered to the patient. |
provider_type | String | The provider-type of the provider-type. The practitioner who is responsible for the services rendered to the patient. |
payment_display | String | The display of the payment. A reference to the payment which is the subject of this notice. |
payment_reference | String | The reference of the payment. A reference to the payment which is the subject of this notice. |
payment_identifier_value | String | The value of the payment-identifier. A reference to the payment which is the subject of this notice. |
payment_type | String | The payment-type of the payment-type. A reference to the payment which is the subject of this notice. |
paymentDate | Date | The date when the above payment action occurred. |
payee_display | String | The display of the payee. The party who will receive or has received payment that is the subject of this notification. |
payee_reference | String | The reference of the payee. The party who will receive or has received payment that is the subject of this notification. |
payee_identifier_value | String | The value of the payee-identifier. The party who will receive or has received payment that is the subject of this notification. |
payee_type | String | The payee-type of the payee-type. The party who will receive or has received payment that is the subject of this notification. |
recipient_display | String | The display of the recipient. The party who is notified of the payment status. |
recipient_reference | String | The reference of the recipient. The party who is notified of the payment status. |
recipient_identifier_value | String | The value of the recipient-identifier. The party who is notified of the payment status. |
recipient_type | String | The recipient-type of the recipient-type. The party who is notified of the payment status. |
amount | String | The amount sent to the payee. |
paymentStatus_coding | String | The coding of the paymentStatus. A code indicating whether payment has been sent or cleared. |
paymentStatus_text | String | The text of the paymentStatus. A code indicating whether payment has been sent or cleared. |
SP_source | String | The SP_source search parameter. |
SP_response | String | The SP_response search parameter. |
SP_payment_status_end | String | The SP_payment_status_end search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_request | String | The SP_request search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_payment_status_start | String | The SP_payment_status_start search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_provider | String | The SP_provider search parameter. |
PaymentReconciliation view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique identifier assigned to this payment reconciliation. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this payment reconciliation. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this payment reconciliation. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this payment reconciliation. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this payment reconciliation. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this payment reconciliation. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this payment reconciliation. |
status | String | The status of the resource instance. |
period_start | Datetime | The start of the period. The period of time for which payments have been gathered into this bulk payment for settlement. |
period_end | Datetime | The end of the period. The period of time for which payments have been gathered into this bulk payment for settlement. |
created | Datetime | The date when the resource was created. |
paymentIssuer_display | String | The display of the paymentIssuer. The party who generated the payment. |
paymentIssuer_reference | String | The reference of the paymentIssuer. The party who generated the payment. |
paymentIssuer_identifier_value | String | The value of the paymentIssuer-identifier. The party who generated the payment. |
paymentIssuer_type | String | The paymentIssuer-type of the paymentIssuer-type. The party who generated the payment. |
request_display | String | The display of the request. Original request resource reference. |
request_reference | String | The reference of the request. Original request resource reference. |
request_identifier_value | String | The value of the request-identifier. Original request resource reference. |
request_type | String | The request-type of the request-type. Original request resource reference. |
requestor_display | String | The display of the requestor. The practitioner who is responsible for the services rendered to the patient. |
requestor_reference | String | The reference of the requestor. The practitioner who is responsible for the services rendered to the patient. |
requestor_identifier_value | String | The value of the requestor-identifier. The practitioner who is responsible for the services rendered to the patient. |
requestor_type | String | The requestor-type of the requestor-type. The practitioner who is responsible for the services rendered to the patient. |
outcome | String | The outcome of a request for a reconciliation. |
disposition | String | A human readable description of the status of the request for the reconciliation. |
paymentDate | Date | The date of payment as indicated on the financial instrument. |
paymentAmount | String | Total payment amount as indicated on the financial instrument. |
paymentIdentifier_value | String | The value of the paymentIdentifier. Issuer's unique identifier for the payment instrument. |
paymentIdentifier_use | String | The paymentIdentifier-use of the paymentIdentifier-use. Issuer's unique identifier for the payment instrument. |
paymentIdentifier_type_coding | String | The coding of the paymentIdentifier-type. Issuer's unique identifier for the payment instrument. |
paymentIdentifier_type_text | String | The text of the paymentIdentifier-type. Issuer's unique identifier for the payment instrument. |
paymentIdentifier_system | String | The paymentIdentifier-system of the paymentIdentifier-system. Issuer's unique identifier for the payment instrument. |
paymentIdentifier_period_start | Datetime | The start of the paymentIdentifier-period. Issuer's unique identifier for the payment instrument. |
paymentIdentifier_period_end | Datetime | The end of the paymentIdentifier-period. Issuer's unique identifier for the payment instrument. |
detail_id | String | The detail-id of the detail-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
detail_extension | String | The detail-extension of the detail-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
detail_modifierExtension | String | The detail-modifierExtension of the detail-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
detail_identifier_value | String | The value of the detail-identifier. Unique identifier for the current payment item for the referenced payable. |
detail_identifier_use | String | The detail-identifier-use of the detail-identifier-use. Unique identifier for the current payment item for the referenced payable. |
detail_identifier_type_coding | String | The coding of the detail-identifier-type. Unique identifier for the current payment item for the referenced payable. |
detail_identifier_type_text | String | The text of the detail-identifier-type. Unique identifier for the current payment item for the referenced payable. |
detail_identifier_system | String | The detail-identifier-system of the detail-identifier-system. Unique identifier for the current payment item for the referenced payable. |
detail_identifier_period_start | Datetime | The start of the detail-identifier-period. Unique identifier for the current payment item for the referenced payable. |
detail_identifier_period_end | Datetime | The end of the detail-identifier-period. Unique identifier for the current payment item for the referenced payable. |
detail_predecessor_value | String | The value of the detail-predecessor. Unique identifier for the prior payment item for the referenced payable. |
detail_predecessor_use | String | The detail-predecessor-use of the detail-predecessor-use. Unique identifier for the prior payment item for the referenced payable. |
detail_predecessor_type_coding | String | The coding of the detail-predecessor-type. Unique identifier for the prior payment item for the referenced payable. |
detail_predecessor_type_text | String | The text of the detail-predecessor-type. Unique identifier for the prior payment item for the referenced payable. |
detail_predecessor_system | String | The detail-predecessor-system of the detail-predecessor-system. Unique identifier for the prior payment item for the referenced payable. |
detail_predecessor_period_start | Datetime | The start of the detail-predecessor-period. Unique identifier for the prior payment item for the referenced payable. |
detail_predecessor_period_end | Datetime | The end of the detail-predecessor-period. Unique identifier for the prior payment item for the referenced payable. |
detail_type_coding | String | The coding of the detail-type. Code to indicate the nature of the payment. |
detail_type_text | String | The text of the detail-type. Code to indicate the nature of the payment. |
detail_request_display | String | The display of the detail-request. A resource, such as a Claim, the evaluation of which could lead to payment. |
detail_request_reference | String | The reference of the detail-request. A resource, such as a Claim, the evaluation of which could lead to payment. |
detail_request_identifier_value | String | The value of the detail-request-identifier. A resource, such as a Claim, the evaluation of which could lead to payment. |
detail_request_type | String | The detail-request-type of the detail-request-type. A resource, such as a Claim, the evaluation of which could lead to payment. |
detail_submitter_display | String | The display of the detail-submitter. The party which submitted the claim or financial transaction. |
detail_submitter_reference | String | The reference of the detail-submitter. The party which submitted the claim or financial transaction. |
detail_submitter_identifier_value | String | The value of the detail-submitter-identifier. The party which submitted the claim or financial transaction. |
detail_submitter_type | String | The detail-submitter-type of the detail-submitter-type. The party which submitted the claim or financial transaction. |
detail_response_display | String | The display of the detail-response. A resource, such as a ClaimResponse, which contains a commitment to payment. |
detail_response_reference | String | The reference of the detail-response. A resource, such as a ClaimResponse, which contains a commitment to payment. |
detail_response_identifier_value | String | The value of the detail-response-identifier. A resource, such as a ClaimResponse, which contains a commitment to payment. |
detail_response_type | String | The detail-response-type of the detail-response-type. A resource, such as a ClaimResponse, which contains a commitment to payment. |
detail_date | Date | The detail-date of the detail-date. The date from the response resource containing a commitment to pay. |
detail_responsible_display | String | The display of the detail-responsible. A reference to the individual who is responsible for inquiries regarding the response and its payment. |
detail_responsible_reference | String | The reference of the detail-responsible. A reference to the individual who is responsible for inquiries regarding the response and its payment. |
detail_responsible_identifier_value | String | The value of the detail-responsible-identifier. A reference to the individual who is responsible for inquiries regarding the response and its payment. |
detail_responsible_type | String | The detail-responsible-type of the detail-responsible-type. A reference to the individual who is responsible for inquiries regarding the response and its payment. |
detail_payee_display | String | The display of the detail-payee. The party which is receiving the payment. |
detail_payee_reference | String | The reference of the detail-payee. The party which is receiving the payment. |
detail_payee_identifier_value | String | The value of the detail-payee-identifier. The party which is receiving the payment. |
detail_payee_type | String | The detail-payee-type of the detail-payee-type. The party which is receiving the payment. |
detail_amount | String | The detail-amount of the detail-amount. The monetary amount allocated from the total payment to the payable. |
formCode_coding | String | The coding of the formCode. A code for the form to be used for printing the content. |
formCode_text | String | The text of the formCode. A code for the form to be used for printing the content. |
processNote_id | String | The processNote-id of the processNote-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
processNote_extension | String | The processNote-extension of the processNote-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
processNote_modifierExtension | String | The processNote-modifierExtension of the processNote-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
processNote_type | String | The processNote-type of the processNote-type. The business purpose of the note text. |
processNote_text | String | The processNote-text of the processNote-text. The explanation or description associated with the processing. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_request | String | The SP_request search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_requestor | String | The SP_requestor search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_payment_issuer | String | The SP_payment_issuer search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
Person view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifier for a person within a particular scope. |
identifier_use | String | The identifier-use of the identifier-use. Identifier for a person within a particular scope. |
identifier_type_coding | String | The coding of the identifier-type. Identifier for a person within a particular scope. |
identifier_type_text | String | The text of the identifier-type. Identifier for a person within a particular scope. |
identifier_system | String | The identifier-system of the identifier-system. Identifier for a person within a particular scope. |
identifier_period_start | String | The start of the identifier-period. Identifier for a person within a particular scope. |
identifier_period_end | String | The end of the identifier-period. Identifier for a person within a particular scope. |
name_use | String | The use of the name. A name associated with the person. |
name_family | String | The family of the name. A name associated with the person. |
name_given | String | The given of the name. A name associated with the person. |
name_prefix | String | The prefix of the name. A name associated with the person. |
name_suffix | String | The suffix of the name. A name associated with the person. |
name_period_start | String | The start of the name-period. A name associated with the person. |
name_period_end | String | The end of the name-period. A name associated with the person. |
telecom_value | String | The value of the telecom. A contact detail for the person, e.g. a telephone number or an email address. |
telecom_system | String | The telecom-system of the telecom-system. A contact detail for the person, e.g. a telephone number or an email address. |
telecom_use | String | The telecom-use of the telecom-use. A contact detail for the person, e.g. a telephone number or an email address. |
telecom_rank | String | The telecom-rank of the telecom-rank. A contact detail for the person, e.g. a telephone number or an email address. |
telecom_period_start | String | The start of the telecom-period. A contact detail for the person, e.g. a telephone number or an email address. |
telecom_period_end | String | The end of the telecom-period. A contact detail for the person, e.g. a telephone number or an email address. |
gender | String | Administrative Gender. |
birthDate | Date | The birth date for the person. |
address_text | String | The text of the address. One or more addresses for the person. |
address_line | String | The line of the address. One or more addresses for the person. |
address_city | String | The city of the address. One or more addresses for the person. |
address_district | String | The district of the address. One or more addresses for the person. |
address_state | String | The state of the address. One or more addresses for the person. |
address_postalCode | String | The postalCode of the address. One or more addresses for the person. |
address_country | String | The country of the address. One or more addresses for the person. |
address_type | String | The address-type of the address-type. One or more addresses for the person. |
address_period_start | String | The start of the address-period. One or more addresses for the person. |
address_period_end | String | The end of the address-period. One or more addresses for the person. |
address_use | String | The address-use of the address-use. One or more addresses for the person. |
photo_data | String | The data of the photo. An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. |
photo_url | String | The url of the photo. An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. |
photo_size | Int | The size of the photo. An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. |
photo_title | String | The title of the photo. An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. |
photo_creation | Datetime | The creation of the photo. An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. |
photo_height | Int | The height of the photo. An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. |
photo_width | Int | The width of the photo. An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. |
photo_frames | Int | The frames of the photo. An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. |
photo_duration | Decimal | The duration of the photo. An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. |
photo_pages | Int | The pages of the photo. An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. |
photo_contentType | String | The photo-contentType of the photo-contentType. An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. |
photo_language | String | The photo-language of the photo-language. An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. |
managingOrganization_display | String | The display of the managingOrganization. The organization that is the custodian of the person record. |
managingOrganization_reference | String | The reference of the managingOrganization. The organization that is the custodian of the person record. |
managingOrganization_identifier_value | String | The value of the managingOrganization-identifier. The organization that is the custodian of the person record. |
managingOrganization_type | String | The managingOrganization-type of the managingOrganization-type. The organization that is the custodian of the person record. |
active | Bool | Whether this person's record is in active use. |
link_id | String | The link-id of the link-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
link_extension | String | The link-extension of the link-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
link_modifierExtension | String | The link-modifierExtension of the link-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
link_target_display | String | The display of the link-target. The resource to which this actual person is associated. |
link_target_reference | String | The reference of the link-target. The resource to which this actual person is associated. |
link_target_identifier_value | String | The value of the link-target-identifier. The resource to which this actual person is associated. |
link_target_type | String | The link-target-type of the link-target-type. The resource to which this actual person is associated. |
link_assurance | String | The link-assurance of the link-assurance. Level of assurance that this link is associated with the target resource. |
SP_source | String | The SP_source search parameter. |
SP_email_end | String | The SP_email_end search parameter. |
SP_phone_start | String | The SP_phone_start search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_telecom_end | String | The SP_telecom_end search parameter. |
SP_address | String | The SP_address search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_link | String | The SP_link search parameter. |
SP_telecom_start | String | The SP_telecom_start search parameter. |
SP_practitioner | String | The SP_practitioner search parameter. |
SP_relatedperson | String | The SP_relatedperson search parameter. |
SP_email_start | String | The SP_email_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_phonetic | String | The SP_phonetic search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_phone_end | String | The SP_phone_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_organization | String | The SP_organization search parameter. |
SP_name | String | The SP_name search parameter. |
PlanDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers. |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_start | String | The start of the identifier-period. A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_end | String | The end of the identifier-period. A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
version | String | The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. |
name | String | A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
title | String | A short, descriptive, user-friendly title for the plan definition. |
subtitle | String | An explanatory or alternate title for the plan definition giving additional information about its content. |
type_coding | String | The coding of the type. A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. |
type_text | String | The text of the type. A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. |
status | String | The status of this plan definition. Enables tracking the life-cycle of the content. |
experimental | Bool | A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
subject_x_coding | String | The coding of the subject[x]. A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. |
subject_x_text | String | The text of the subject[x]. A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. |
date | Datetime | The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes. |
publisher | String | The name of the organization or individual that published the plan definition. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
description | String | A free text natural language description of the plan definition from a consumer's perspective. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances. |
jurisdiction_coding | String | The coding of the jurisdiction. A legal or geographic region in which the plan definition is intended to be used. |
jurisdiction_text | String | The text of the jurisdiction. A legal or geographic region in which the plan definition is intended to be used. |
purpose | String | Explanation of why this plan definition is needed and why it has been designed as it has. |
usage | String | A detailed description of how the plan definition is used from a clinical perspective. |
copyright | String | A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition. |
approvalDate | Date | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
lastReviewDate | Date | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
effectivePeriod_start | Datetime | The start of the effectivePeriod. The period during which the plan definition content was or is planned to be in active use. |
effectivePeriod_end | Datetime | The end of the effectivePeriod. The period during which the plan definition content was or is planned to be in active use. |
topic_coding | String | The coding of the topic. Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. |
topic_text | String | The text of the topic. Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. |
author | String | An individiual or organization primarily involved in the creation and maintenance of the content. |
editor | String | An individual or organization primarily responsible for internal coherence of the content. |
reviewer | String | An individual or organization primarily responsible for review of some aspect of the content. |
endorser | String | An individual or organization responsible for officially endorsing the content for use in some setting. |
relatedArtifact | String | Related artifacts such as additional documentation, justification, or bibliographic references. |
library | String | A reference to a Library resource containing any formal logic used by the plan definition. |
goal_id | String | The goal-id of the goal-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
goal_extension | String | The goal-extension of the goal-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
goal_modifierExtension | String | The goal-modifierExtension of the goal-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
goal_category_coding | String | The coding of the goal-category. Indicates a category the goal falls within. |
goal_category_text | String | The text of the goal-category. Indicates a category the goal falls within. |
goal_description_coding | String | The coding of the goal-description. Human-readable and/or coded description of a specific desired objective of care, such as 'control blood pressure' or 'negotiate an obstacle course' or 'dance with child at wedding'. |
goal_description_text | String | The text of the goal-description. Human-readable and/or coded description of a specific desired objective of care, such as 'control blood pressure' or 'negotiate an obstacle course' or 'dance with child at wedding'. |
goal_priority_coding | String | The coding of the goal-priority. Identifies the expected level of importance associated with reaching/sustaining the defined goal. |
goal_priority_text | String | The text of the goal-priority. Identifies the expected level of importance associated with reaching/sustaining the defined goal. |
goal_start_coding | String | The coding of the goal-start. The event after which the goal should begin being pursued. |
goal_start_text | String | The text of the goal-start. The event after which the goal should begin being pursued. |
goal_addresses_coding | String | The coding of the goal-addresses. Identifies problems, conditions, issues, or concerns the goal is intended to address. |
goal_addresses_text | String | The text of the goal-addresses. Identifies problems, conditions, issues, or concerns the goal is intended to address. |
goal_documentation | String | The goal-documentation of the goal-documentation. Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources. |
goal_target_id | String | The goal-target-id of the goal-target-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
goal_target_extension | String | The goal-target-extension of the goal-target-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
goal_target_modifierExtension | String | The goal-target-modifierExtension of the goal-target-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
goal_target_measure_coding | String | The coding of the goal-target-measure. The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. |
goal_target_measure_text | String | The text of the goal-target-measure. The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. |
goal_target_detail_x_value | Decimal | The value of the goal-target-detail[x]. The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. |
goal_target_detail_x_unit | String | The unit of the goal-target-detail[x]. The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. |
goal_target_detail_x_system | String | The system of the goal-target-detail[x]. The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. |
goal_target_detail_x_comparator | String | The goal-target-detail[x]-comparator of the goal-target-detail[x]-comparator. The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. |
goal_target_detail_x_code | String | The goal-target-detail[x]-code of the goal-target-detail[x]-code. The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. |
goal_target_due | String | The goal-target-due of the goal-target-due. Indicates the timeframe after the start of the goal in which the goal should be met. |
action_id | String | The action-id of the action-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
action_extension | String | The action-extension of the action-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
action_modifierExtension | String | The action-modifierExtension of the action-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
action_prefix | String | The action-prefix of the action-prefix. A user-visible prefix for the action. |
action_title | String | The action-title of the action-title. The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC. |
action_description | String | The action-description of the action-description. A brief description of the action used to provide a summary to display to the user. |
action_textEquivalent | String | The action-textEquivalent of the action-textEquivalent. A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically. |
action_priority | String | The action-priority of the action-priority. Indicates how quickly the action should be addressed with respect to other actions. |
action_code_coding | String | The coding of the action-code. A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. |
action_code_text | String | The text of the action-code. A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. |
action_reason_coding | String | The coding of the action-reason. A description of why this action is necessary or appropriate. |
action_reason_text | String | The text of the action-reason. A description of why this action is necessary or appropriate. |
action_documentation | String | The action-documentation of the action-documentation. Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources. |
action_goalId | String | The action-goalId of the action-goalId. Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action. |
action_subject_x_coding | String | The coding of the action-subject[x]. A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. |
action_subject_x_text | String | The text of the action-subject[x]. A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. |
action_trigger | String | The action-trigger of the action-trigger. A description of when the action should be triggered. |
action_condition_id | String | The action-condition-id of the action-condition-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
action_condition_extension | String | The action-condition-extension of the action-condition-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
action_condition_modifierExtension | String | The action-condition-modifierExtension of the action-condition-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
action_condition_kind | String | The action-condition-kind of the action-condition-kind. The kind of condition. |
action_condition_expression | String | The action-condition-expression of the action-condition-expression. An expression that returns true or false, indicating whether the condition is satisfied. |
action_input | String | The action-input of the action-input. Defines input data requirements for the action. |
action_output | String | The action-output of the action-output. Defines the outputs of the action, if any. |
action_relatedAction_id | String | The action-relatedAction-id of the action-relatedAction-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
action_relatedAction_extension | String | The action-relatedAction-extension of the action-relatedAction-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
action_relatedAction_modifierExtension | String | The action-relatedAction-modifierExtension of the action-relatedAction-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
action_relatedAction_actionId | String | The action-relatedAction-actionId of the action-relatedAction-actionId. The element id of the related action. |
action_relatedAction_relationship | String | The action-relatedAction-relationship of the action-relatedAction-relationship. The relationship of this action to the related action. |
action_relatedAction_offset_x_ | String | The action-relatedAction-offset[x] of the action-relatedAction-offset[x]. A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. |
action_timing_x_ | Datetime | The action-timing[x] of the action-timing[x]. An optional value describing when the action should be performed. |
action_participant_id | String | The action-participant-id of the action-participant-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
action_participant_extension | String | The action-participant-extension of the action-participant-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
action_participant_modifierExtension | String | The action-participant-modifierExtension of the action-participant-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
action_participant_type | String | The action-participant-type of the action-participant-type. The type of participant in the action. |
action_participant_role_coding | String | The coding of the action-participant-role. The role the participant should play in performing the described action. |
action_participant_role_text | String | The text of the action-participant-role. The role the participant should play in performing the described action. |
action_type_coding | String | The coding of the action-type. The type of action to perform (create, update, remove). |
action_type_text | String | The text of the action-type. The type of action to perform (create, update, remove). |
action_groupingBehavior | String | The action-groupingBehavior of the action-groupingBehavior. Defines the grouping behavior for the action and its children. |
action_selectionBehavior | String | The action-selectionBehavior of the action-selectionBehavior. Defines the selection behavior for the action and its children. |
action_requiredBehavior | String | The action-requiredBehavior of the action-requiredBehavior. Defines the required behavior for the action. |
action_precheckBehavior | String | The action-precheckBehavior of the action-precheckBehavior. Defines whether the action should usually be preselected. |
action_cardinalityBehavior | String | The action-cardinalityBehavior of the action-cardinalityBehavior. Defines whether the action can be selected multiple times. |
action_definition_x_ | String | The action-definition[x] of the action-definition[x]. A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken. |
action_transform | String | The action-transform of the action-transform. A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. |
action_dynamicValue_id | String | The action-dynamicValue-id of the action-dynamicValue-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
action_dynamicValue_extension | String | The action-dynamicValue-extension of the action-dynamicValue-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
action_dynamicValue_modifierExtension | String | The action-dynamicValue-modifierExtension of the action-dynamicValue-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
action_dynamicValue_path | String | The action-dynamicValue-path of the action-dynamicValue-path. The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). |
action_dynamicValue_expression | String | The action-dynamicValue-expression of the action-dynamicValue-expression. An expression specifying the value of the customized element. |
SP_context_end | String | The SP_context_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_depends_on | String | The SP_depends_on search parameter. |
SP_predecessor | String | The SP_predecessor search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_jurisdiction_start | String | The SP_jurisdiction_start search parameter. |
SP_effective | String | The SP_effective search parameter. |
SP_definition | String | The SP_definition search parameter. |
SP_topic_end | String | The SP_topic_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_context_type_start | String | The SP_context_type_start search parameter. |
SP_context_quantity | String | The SP_context_quantity search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_context_type_value | String | The SP_context_type_value search parameter. |
SP_successor | String | The SP_successor search parameter. |
SP_context_type_quantity | String | The SP_context_type_quantity search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_derived_from | String | The SP_derived_from search parameter. |
SP_context_type_end | String | The SP_context_type_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_context_start | String | The SP_context_start search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_composed_of | String | The SP_composed_of search parameter. |
SP_jurisdiction_end | String | The SP_jurisdiction_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_topic_start | String | The SP_topic_start search parameter. |
Practitioner view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. An identifier that applies to this person in this role. |
identifier_use | String | The identifier-use of the identifier-use. An identifier that applies to this person in this role. |
identifier_type_coding | String | The coding of the identifier-type. An identifier that applies to this person in this role. |
identifier_type_text | String | The text of the identifier-type. An identifier that applies to this person in this role. |
identifier_system | String | The identifier-system of the identifier-system. An identifier that applies to this person in this role. |
identifier_period_start | String | The start of the identifier-period. An identifier that applies to this person in this role. |
identifier_period_end | String | The end of the identifier-period. An identifier that applies to this person in this role. |
active | Bool | Whether this practitioner's record is in active use. |
name_use | String | The use of the name. The name(s) associated with the practitioner. |
name_family | String | The family of the name. The name(s) associated with the practitioner. |
name_given | String | The given of the name. The name(s) associated with the practitioner. |
name_prefix | String | The prefix of the name. The name(s) associated with the practitioner. |
name_suffix | String | The suffix of the name. The name(s) associated with the practitioner. |
name_period_start | String | The start of the name-period. The name(s) associated with the practitioner. |
name_period_end | String | The end of the name-period. The name(s) associated with the practitioner. |
telecom_value | String | The value of the telecom. A contact detail for the practitioner, e.g. a telephone number or an email address. |
telecom_system | String | The telecom-system of the telecom-system. A contact detail for the practitioner, e.g. a telephone number or an email address. |
telecom_use | String | The telecom-use of the telecom-use. A contact detail for the practitioner, e.g. a telephone number or an email address. |
telecom_rank | String | The telecom-rank of the telecom-rank. A contact detail for the practitioner, e.g. a telephone number or an email address. |
telecom_period_start | String | The start of the telecom-period. A contact detail for the practitioner, e.g. a telephone number or an email address. |
telecom_period_end | String | The end of the telecom-period. A contact detail for the practitioner, e.g. a telephone number or an email address. |
address_text | String | The text of the address. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.. |
address_line | String | The line of the address. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.. |
address_city | String | The city of the address. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.. |
address_district | String | The district of the address. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.. |
address_state | String | The state of the address. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.. |
address_postalCode | String | The postalCode of the address. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.. |
address_country | String | The country of the address. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.. |
address_type | String | The address-type of the address-type. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.. |
address_period_start | String | The start of the address-period. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.. |
address_period_end | String | The end of the address-period. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.. |
address_use | String | The address-use of the address-use. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.. |
gender | String | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
birthDate | Date | The date of birth for the practitioner. |
photo_data | String | The data of the photo. Image of the person. |
photo_url | String | The url of the photo. Image of the person. |
photo_size | String | The size of the photo. Image of the person. |
photo_title | String | The title of the photo. Image of the person. |
photo_creation | String | The creation of the photo. Image of the person. |
photo_height | String | The height of the photo. Image of the person. |
photo_width | String | The width of the photo. Image of the person. |
photo_frames | String | The frames of the photo. Image of the person. |
photo_duration | String | The duration of the photo. Image of the person. |
photo_pages | String | The pages of the photo. Image of the person. |
photo_contentType | String | The photo-contentType of the photo-contentType. Image of the person. |
photo_language | String | The photo-language of the photo-language. Image of the person. |
qualification_id | String | The qualification-id of the qualification-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
qualification_extension | String | The qualification-extension of the qualification-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
qualification_modifierExtension | String | The qualification-modifierExtension of the qualification-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
qualification_identifier_value | String | The value of the qualification-identifier. An identifier that applies to this person's qualification in this role. |
qualification_identifier_use | String | The qualification-identifier-use of the qualification-identifier-use. An identifier that applies to this person's qualification in this role. |
qualification_identifier_type_coding | String | The coding of the qualification-identifier-type. An identifier that applies to this person's qualification in this role. |
qualification_identifier_type_text | String | The text of the qualification-identifier-type. An identifier that applies to this person's qualification in this role. |
qualification_identifier_system | String | The qualification-identifier-system of the qualification-identifier-system. An identifier that applies to this person's qualification in this role. |
qualification_identifier_period_start | String | The start of the qualification-identifier-period. An identifier that applies to this person's qualification in this role. |
qualification_identifier_period_end | String | The end of the qualification-identifier-period. An identifier that applies to this person's qualification in this role. |
qualification_code_coding | String | The coding of the qualification-code. Coded representation of the qualification. |
qualification_code_text | String | The text of the qualification-code. Coded representation of the qualification. |
qualification_period_start | Datetime | The start of the qualification-period. Period during which the qualification is valid. |
qualification_period_end | Datetime | The end of the qualification-period. Period during which the qualification is valid. |
qualification_issuer_display | String | The display of the qualification-issuer. Organization that regulates and issues the qualification. |
qualification_issuer_reference | String | The reference of the qualification-issuer. Organization that regulates and issues the qualification. |
qualification_issuer_identifier_value | String | The value of the qualification-issuer-identifier. Organization that regulates and issues the qualification. |
qualification_issuer_type | String | The qualification-issuer-type of the qualification-issuer-type. Organization that regulates and issues the qualification. |
communication_coding | String | The coding of the communication. A language the practitioner can use in patient communication. |
communication_text | String | The text of the communication. A language the practitioner can use in patient communication. |
SP_source | String | The SP_source search parameter. |
SP_communication_start | String | The SP_communication_start search parameter. |
SP_email_end | String | The SP_email_end search parameter. |
SP_phone_start | String | The SP_phone_start search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_telecom_end | String | The SP_telecom_end search parameter. |
SP_address | String | The SP_address search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_telecom_start | String | The SP_telecom_start search parameter. |
SP_email_start | String | The SP_email_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_communication_end | String | The SP_communication_end search parameter. |
SP_given | String | The SP_given search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_phonetic | String | The SP_phonetic search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_phone_end | String | The SP_phone_end search parameter. |
SP_family | String | The SP_family search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_name | String | The SP_name search parameter. |
PractitionerRole view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business Identifiers that are specific to a role/location. |
identifier_use | String | The identifier-use of the identifier-use. Business Identifiers that are specific to a role/location. |
identifier_type_coding | String | The coding of the identifier-type. Business Identifiers that are specific to a role/location. |
identifier_type_text | String | The text of the identifier-type. Business Identifiers that are specific to a role/location. |
identifier_system | String | The identifier-system of the identifier-system. Business Identifiers that are specific to a role/location. |
identifier_period_start | String | The start of the identifier-period. Business Identifiers that are specific to a role/location. |
identifier_period_end | String | The end of the identifier-period. Business Identifiers that are specific to a role/location. |
active | Bool | Whether this practitioner role record is in active use. |
period_start | Datetime | The start of the period. The period during which the person is authorized to act as a practitioner in these role(s) for the organization. |
period_end | Datetime | The end of the period. The period during which the person is authorized to act as a practitioner in these role(s) for the organization. |
practitioner_display | String | The display of the practitioner. Practitioner that is able to provide the defined services for the organization. |
practitioner_reference | String | The reference of the practitioner. Practitioner that is able to provide the defined services for the organization. |
practitioner_identifier_value | String | The value of the practitioner-identifier. Practitioner that is able to provide the defined services for the organization. |
practitioner_type | String | The practitioner-type of the practitioner-type. Practitioner that is able to provide the defined services for the organization. |
organization_display | String | The display of the organization. The organization where the Practitioner performs the roles associated. |
organization_reference | String | The reference of the organization. The organization where the Practitioner performs the roles associated. |
organization_identifier_value | String | The value of the organization-identifier. The organization where the Practitioner performs the roles associated. |
organization_type | String | The organization-type of the organization-type. The organization where the Practitioner performs the roles associated. |
code_coding | String | The coding of the code. Roles which this practitioner is authorized to perform for the organization. |
code_text | String | The text of the code. Roles which this practitioner is authorized to perform for the organization. |
specialty_coding | String | The coding of the specialty. Specific specialty of the practitioner. |
specialty_text | String | The text of the specialty. Specific specialty of the practitioner. |
location_display | String | The display of the location. The location(s) at which this practitioner provides care. |
location_reference | String | The reference of the location. The location(s) at which this practitioner provides care. |
location_identifier_value | String | The value of the location-identifier. The location(s) at which this practitioner provides care. |
location_type | String | The location-type of the location-type. The location(s) at which this practitioner provides care. |
healthcareService_display | String | The display of the healthcareService. The list of healthcare services that this worker provides for this role's Organization/Location(s). |
healthcareService_reference | String | The reference of the healthcareService. The list of healthcare services that this worker provides for this role's Organization/Location(s). |
healthcareService_identifier_value | String | The value of the healthcareService-identifier. The list of healthcare services that this worker provides for this role's Organization/Location(s). |
healthcareService_type | String | The healthcareService-type of the healthcareService-type. The list of healthcare services that this worker provides for this role's Organization/Location(s). |
telecom_value | String | The value of the telecom. Contact details that are specific to the role/location/service. |
telecom_system | String | The telecom-system of the telecom-system. Contact details that are specific to the role/location/service. |
telecom_use | String | The telecom-use of the telecom-use. Contact details that are specific to the role/location/service. |
telecom_rank | String | The telecom-rank of the telecom-rank. Contact details that are specific to the role/location/service. |
telecom_period_start | String | The start of the telecom-period. Contact details that are specific to the role/location/service. |
telecom_period_end | String | The end of the telecom-period. Contact details that are specific to the role/location/service. |
availableTime_id | String | The availableTime-id of the availableTime-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
availableTime_extension | String | The availableTime-extension of the availableTime-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
availableTime_modifierExtension | String | The availableTime-modifierExtension of the availableTime-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
availableTime_daysOfWeek | String | The availableTime-daysOfWeek of the availableTime-daysOfWeek. Indicates which days of the week are available between the start and end Times. |
availableTime_allDay | Bool | The availableTime-allDay of the availableTime-allDay. Is this always available? (hence times are irrelevant) e.g. 24 hour service. |
availableTime_availableStartTime | Time | The availableTime-availableStartTime of the availableTime-availableStartTime. The opening time of day. Note: If the AllDay flag is set, then this time is ignored. |
availableTime_availableEndTime | Time | The availableTime-availableEndTime of the availableTime-availableEndTime. The closing time of day. Note: If the AllDay flag is set, then this time is ignored. |
notAvailable_id | String | The notAvailable-id of the notAvailable-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
notAvailable_extension | String | The notAvailable-extension of the notAvailable-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
notAvailable_modifierExtension | String | The notAvailable-modifierExtension of the notAvailable-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
notAvailable_description | String | The notAvailable-description of the notAvailable-description. The reason that can be presented to the user as to why this time is not available. |
notAvailable_during_start | Datetime | The start of the notAvailable-during. Service is not available (seasonally or for a public holiday) from this date. |
notAvailable_during_end | Datetime | The end of the notAvailable-during. Service is not available (seasonally or for a public holiday) from this date. |
availabilityExceptions | String | A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. |
endpoint_display | String | The display of the endpoint. Technical endpoints providing access to services operated for the practitioner with this role. |
endpoint_reference | String | The reference of the endpoint. Technical endpoints providing access to services operated for the practitioner with this role. |
endpoint_identifier_value | String | The value of the endpoint-identifier. Technical endpoints providing access to services operated for the practitioner with this role. |
endpoint_type | String | The endpoint-type of the endpoint-type. Technical endpoints providing access to services operated for the practitioner with this role. |
SP_location | String | The SP_location search parameter. |
SP_source | String | The SP_source search parameter. |
SP_email_end | String | The SP_email_end search parameter. |
SP_phone_start | String | The SP_phone_start search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_telecom_end | String | The SP_telecom_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_role_start | String | The SP_role_start search parameter. |
SP_specialty_end | String | The SP_specialty_end search parameter. |
SP_endpoint | String | The SP_endpoint search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_telecom_start | String | The SP_telecom_start search parameter. |
SP_practitioner | String | The SP_practitioner search parameter. |
SP_email_start | String | The SP_email_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_specialty_start | String | The SP_specialty_start search parameter. |
SP_role_end | String | The SP_role_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_phone_end | String | The SP_phone_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_date | String | The SP_date search parameter. |
SP_service | String | The SP_service search parameter. |
SP_organization | String | The SP_organization search parameter. |
Procedure view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server. |
instantiatesCanonical | String | The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure. |
instantiatesUri | String | The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure. |
basedOn_display | String | The display of the basedOn. A reference to a resource that contains details of the request for this procedure. |
basedOn_reference | String | The reference of the basedOn. A reference to a resource that contains details of the request for this procedure. |
basedOn_identifier_value | String | The value of the basedOn-identifier. A reference to a resource that contains details of the request for this procedure. |
basedOn_type | String | The basedOn-type of the basedOn-type. A reference to a resource that contains details of the request for this procedure. |
partOf_display | String | The display of the partOf. A larger event of which this particular procedure is a component or step. |
partOf_reference | String | The reference of the partOf. A larger event of which this particular procedure is a component or step. |
partOf_identifier_value | String | The value of the partOf-identifier. A larger event of which this particular procedure is a component or step. |
partOf_type | String | The partOf-type of the partOf-type. A larger event of which this particular procedure is a component or step. |
status | String | A code specifying the state of the procedure. Generally, this will be the in-progress or completed state. |
statusReason_coding | String | The coding of the statusReason. Captures the reason for the current state of the procedure. |
statusReason_text | String | The text of the statusReason. Captures the reason for the current state of the procedure. |
category_coding | String | The coding of the category. A code that classifies the procedure for searching, sorting and display purposes (e.g. 'Surgical Procedure'). |
category_text | String | The text of the category. A code that classifies the procedure for searching, sorting and display purposes (e.g. 'Surgical Procedure'). |
code_coding | String | The coding of the code. The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. 'Laparoscopic Appendectomy'). |
code_text | String | The text of the code. The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. 'Laparoscopic Appendectomy'). |
subject_display | String | The display of the subject. The person, animal or group on which the procedure was performed. |
subject_reference | String | The reference of the subject. The person, animal or group on which the procedure was performed. |
subject_identifier_value | String | The value of the subject-identifier. The person, animal or group on which the procedure was performed. |
subject_type | String | The subject-type of the subject-type. The person, animal or group on which the procedure was performed. |
encounter_display | String | The display of the encounter. The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated. |
encounter_reference | String | The reference of the encounter. The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated. |
encounter_identifier_value | String | The value of the encounter-identifier. The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated. |
encounter_type | String | The encounter-type of the encounter-type. The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated. |
performed_x_ | Datetime | Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured. |
recorder_display | String | The display of the recorder. Individual who recorded the record and takes responsibility for its content. |
recorder_reference | String | The reference of the recorder. Individual who recorded the record and takes responsibility for its content. |
recorder_identifier_value | String | The value of the recorder-identifier. Individual who recorded the record and takes responsibility for its content. |
recorder_type | String | The recorder-type of the recorder-type. Individual who recorded the record and takes responsibility for its content. |
asserter_display | String | The display of the asserter. Individual who is making the procedure statement. |
asserter_reference | String | The reference of the asserter. Individual who is making the procedure statement. |
asserter_identifier_value | String | The value of the asserter-identifier. Individual who is making the procedure statement. |
asserter_type | String | The asserter-type of the asserter-type. Individual who is making the procedure statement. |
performer_id | String | The performer-id of the performer-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
performer_extension | String | The performer-extension of the performer-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
performer_modifierExtension | String | The performer-modifierExtension of the performer-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
performer_function_coding | String | The coding of the performer-function. Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist. |
performer_function_text | String | The text of the performer-function. Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist. |
performer_actor_display | String | The display of the performer-actor. The practitioner who was involved in the procedure. |
performer_actor_reference | String | The reference of the performer-actor. The practitioner who was involved in the procedure. |
performer_actor_identifier_value | String | The value of the performer-actor-identifier. The practitioner who was involved in the procedure. |
performer_actor_type | String | The performer-actor-type of the performer-actor-type. The practitioner who was involved in the procedure. |
performer_onBehalfOf_display | String | The display of the performer-onBehalfOf. The organization the device or practitioner was acting on behalf of. |
performer_onBehalfOf_reference | String | The reference of the performer-onBehalfOf. The organization the device or practitioner was acting on behalf of. |
performer_onBehalfOf_identifier_value | String | The value of the performer-onBehalfOf-identifier. The organization the device or practitioner was acting on behalf of. |
performer_onBehalfOf_type | String | The performer-onBehalfOf-type of the performer-onBehalfOf-type. The organization the device or practitioner was acting on behalf of. |
location_display | String | The display of the location. The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant. |
location_reference | String | The reference of the location. The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant. |
location_identifier_value | String | The value of the location-identifier. The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant. |
location_type | String | The location-type of the location-type. The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant. |
reasonCode_coding | String | The coding of the reasonCode. The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text. |
reasonCode_text | String | The text of the reasonCode. The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text. |
reasonReference_display | String | The display of the reasonReference. The justification of why the procedure was performed. |
reasonReference_reference | String | The reference of the reasonReference. The justification of why the procedure was performed. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. The justification of why the procedure was performed. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. The justification of why the procedure was performed. |
bodySite_coding | String | The coding of the bodySite. Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion. |
bodySite_text | String | The text of the bodySite. Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion. |
outcome_coding | String | The coding of the outcome. The outcome of the procedure - did it resolve the reasons for the procedure being performed?. |
outcome_text | String | The text of the outcome. The outcome of the procedure - did it resolve the reasons for the procedure being performed?. |
report_display | String | The display of the report. This could be a histology result, pathology report, surgical report, etc. |
report_reference | String | The reference of the report. This could be a histology result, pathology report, surgical report, etc. |
report_identifier_value | String | The value of the report-identifier. This could be a histology result, pathology report, surgical report, etc. |
report_type | String | The report-type of the report-type. This could be a histology result, pathology report, surgical report, etc. |
complication_coding | String | The coding of the complication. Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues. |
complication_text | String | The text of the complication. Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues. |
complicationDetail_display | String | The display of the complicationDetail. Any complications that occurred during the procedure, or in the immediate post-performance period. |
complicationDetail_reference | String | The reference of the complicationDetail. Any complications that occurred during the procedure, or in the immediate post-performance period. |
complicationDetail_identifier_value | String | The value of the complicationDetail-identifier. Any complications that occurred during the procedure, or in the immediate post-performance period. |
complicationDetail_type | String | The complicationDetail-type of the complicationDetail-type. Any complications that occurred during the procedure, or in the immediate post-performance period. |
followUp_coding | String | The coding of the followUp. If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used. |
followUp_text | String | The text of the followUp. If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used. |
note | String | Any other notes and comments about the procedure. |
focalDevice_id | String | The focalDevice-id of the focalDevice-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
focalDevice_extension | String | The focalDevice-extension of the focalDevice-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
focalDevice_modifierExtension | String | The focalDevice-modifierExtension of the focalDevice-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
focalDevice_action_coding | String | The coding of the focalDevice-action. The kind of change that happened to the device during the procedure. |
focalDevice_action_text | String | The text of the focalDevice-action. The kind of change that happened to the device during the procedure. |
focalDevice_manipulated_display | String | The display of the focalDevice-manipulated. The device that was manipulated (changed) during the procedure. |
focalDevice_manipulated_reference | String | The reference of the focalDevice-manipulated. The device that was manipulated (changed) during the procedure. |
focalDevice_manipulated_identifier_value | String | The value of the focalDevice-manipulated-identifier. The device that was manipulated (changed) during the procedure. |
focalDevice_manipulated_type | String | The focalDevice-manipulated-type of the focalDevice-manipulated-type. The device that was manipulated (changed) during the procedure. |
usedReference_display | String | The display of the usedReference. Identifies medications, devices and any other substance used as part of the procedure. |
usedReference_reference | String | The reference of the usedReference. Identifies medications, devices and any other substance used as part of the procedure. |
usedReference_identifier_value | String | The value of the usedReference-identifier. Identifies medications, devices and any other substance used as part of the procedure. |
usedReference_type | String | The usedReference-type of the usedReference-type. Identifies medications, devices and any other substance used as part of the procedure. |
usedCode_coding | String | The coding of the usedCode. Identifies coded items that were used as part of the procedure. |
usedCode_text | String | The text of the usedCode. Identifies coded items that were used as part of the procedure. |
SP_location | String | The SP_location search parameter. |
SP_source | String | The SP_source search parameter. |
SP_performer | String | The SP_performer search parameter. |
SP_instantiates_canonical | String | The SP_instantiates_canonical search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_reason_reference | String | The SP_reason_reference search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_instantiates_uri | String | The SP_instantiates_uri search parameter. |
SP_based_on | String | The SP_based_on search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_reason_code_start | String | The SP_reason_code_start search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_part_of | String | The SP_part_of search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_reason_code_end | String | The SP_reason_code_end search parameter. |
SP_date | String | The SP_date search parameter. |
Questionnaire view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers. |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_start | String | The start of the identifier-period. A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_end | String | The end of the identifier-period. A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. |
version | String | The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
name | String | A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
title | String | A short, descriptive, user-friendly title for the questionnaire. |
derivedFrom | String | The URL of a Questionnaire that this Questionnaire is based on. |
status | String | The status of this questionnaire. Enables tracking the life-cycle of the content. |
experimental | Bool | A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
subjectType | String | The types of subjects that can be the subject of responses created for the questionnaire. |
date | Datetime | The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes. |
publisher | String | The name of the organization or individual that published the questionnaire. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
description | String | A free text natural language description of the questionnaire from a consumer's perspective. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances. |
jurisdiction_coding | String | The coding of the jurisdiction. A legal or geographic region in which the questionnaire is intended to be used. |
jurisdiction_text | String | The text of the jurisdiction. A legal or geographic region in which the questionnaire is intended to be used. |
purpose | String | Explanation of why this questionnaire is needed and why it has been designed as it has. |
copyright | String | A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire. |
approvalDate | Date | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
lastReviewDate | Date | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
effectivePeriod_start | Datetime | The start of the effectivePeriod. The period during which the questionnaire content was or is planned to be in active use. |
effectivePeriod_end | Datetime | The end of the effectivePeriod. The period during which the questionnaire content was or is planned to be in active use. |
code_version | String | The version of the code. An identifier for this question or group of questions in a particular terminology such as LOINC. |
code | String | An identifier for this question or group of questions in a particular terminology such as LOINC. |
code_display | String | The display of the code. An identifier for this question or group of questions in a particular terminology such as LOINC. |
code_userSelected | String | The userSelected of the code. An identifier for this question or group of questions in a particular terminology such as LOINC. |
code_system | String | The code-system of the code-system. An identifier for this question or group of questions in a particular terminology such as LOINC. |
item_id | String | The item-id of the item-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_extension | String | The item-extension of the item-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_modifierExtension | String | The item-modifierExtension of the item-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_linkId | String | The item-linkId of the item-linkId. An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource. |
item_definition | String | The item-definition of the item-definition. This element is a URI that refers to an [ElementDefinition](elementdefinition.html) that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value: * code (ElementDefinition.code) * type (ElementDefinition.type) * required (ElementDefinition.min) * repeats (ElementDefinition.max) * maxLength (ElementDefinition.maxLength) * answerValueSet (ElementDefinition.binding) * options (ElementDefinition.binding). |
item_code_version | String | The version of the item-code. A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). |
item_code_code | String | The code of the item-code. A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). |
item_code_display | String | The display of the item-code. A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). |
item_code_userSelected | String | The userSelected of the item-code. A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). |
item_code_system | String | The item-code-system of the item-code-system. A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). |
item_prefix | String | The item-prefix of the item-prefix. A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire. |
item_text | String | The item-text of the item-text. The name of a section, the text of a question or text content for a display item. |
item_type | String | The item-type of the item-type. The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.). |
item_enableWhen_id | String | The item-enableWhen-id of the item-enableWhen-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_enableWhen_extension | String | The item-enableWhen-extension of the item-enableWhen-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_enableWhen_modifierExtension | String | The item-enableWhen-modifierExtension of the item-enableWhen-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_enableWhen_question | String | The item-enableWhen-question of the item-enableWhen-question. The linkId for the question whose answer (or lack of answer) governs whether this item is enabled. |
item_enableWhen_operator | String | The item-enableWhen-operator of the item-enableWhen-operator. Specifies the criteria by which the question is enabled. |
item_enableWhen_answer_x_ | Bool | The item-enableWhen-answer[x] of the item-enableWhen-answer[x]. A value that the referenced question is tested using the specified operator in order for the item to be enabled. |
item_enableBehavior | String | The item-enableBehavior of the item-enableBehavior. Controls how multiple enableWhen values are interpreted - whether all or any must be true. |
item_required | Bool | The item-required of the item-required. An indication, if true, that the item must be present in a 'completed' QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire. |
item_repeats | Bool | The item-repeats of the item-repeats. An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups. |
item_readOnly | Bool | The item-readOnly of the item-readOnly. An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire. |
item_maxLength | Int | The item-maxLength of the item-maxLength. The maximum number of characters that are permitted in the answer to be considered a 'valid' QuestionnaireResponse. |
item_answerValueSet | String | The item-answerValueSet of the item-answerValueSet. A reference to a value set containing a list of codes representing permitted answers for a 'choice' or 'open-choice' question. |
item_answerOption_id | String | The item-answerOption-id of the item-answerOption-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_answerOption_extension | String | The item-answerOption-extension of the item-answerOption-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_answerOption_modifierExtension | String | The item-answerOption-modifierExtension of the item-answerOption-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_answerOption_value_x_ | Int | The item-answerOption-value[x] of the item-answerOption-value[x]. A potential answer that's allowed as the answer to this question. |
item_answerOption_initialSelected | Bool | The item-answerOption-initialSelected of the item-answerOption-initialSelected. Indicates whether the answer value is selected when the list of possible answers is initially shown. |
item_initial_id | String | The item-initial-id of the item-initial-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_initial_extension | String | The item-initial-extension of the item-initial-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_initial_modifierExtension | String | The item-initial-modifierExtension of the item-initial-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_initial_value_x_ | Bool | The item-initial-value[x] of the item-initial-value[x]. The actual value to for an initial answer. |
SP_subject_type_start | String | The SP_subject_type_start search parameter. |
SP_context_end | String | The SP_context_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_jurisdiction_start | String | The SP_jurisdiction_start search parameter. |
SP_effective | String | The SP_effective search parameter. |
SP_definition | String | The SP_definition search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_context_type_start | String | The SP_context_type_start search parameter. |
SP_context_quantity | String | The SP_context_quantity search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_context_type_value | String | The SP_context_type_value search parameter. |
SP_context_type_quantity | String | The SP_context_type_quantity search parameter. |
SP_context_type_end | String | The SP_context_type_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_context_start | String | The SP_context_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_jurisdiction_end | String | The SP_jurisdiction_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_subject_type_end | String | The SP_subject_type_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
QuestionnaireResponse view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A business identifier assigned to a particular completed (or partially completed) questionnaire. |
identifier_use | String | The identifier-use of the identifier-use. A business identifier assigned to a particular completed (or partially completed) questionnaire. |
identifier_type_coding | String | The coding of the identifier-type. A business identifier assigned to a particular completed (or partially completed) questionnaire. |
identifier_type_text | String | The text of the identifier-type. A business identifier assigned to a particular completed (or partially completed) questionnaire. |
identifier_system | String | The identifier-system of the identifier-system. A business identifier assigned to a particular completed (or partially completed) questionnaire. |
identifier_period_start | Datetime | The start of the identifier-period. A business identifier assigned to a particular completed (or partially completed) questionnaire. |
identifier_period_end | Datetime | The end of the identifier-period. A business identifier assigned to a particular completed (or partially completed) questionnaire. |
basedOn_display | String | The display of the basedOn. The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. |
basedOn_reference | String | The reference of the basedOn. The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. |
basedOn_identifier_value | String | The value of the basedOn-identifier. The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. |
basedOn_type | String | The basedOn-type of the basedOn-type. The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. |
partOf_display | String | The display of the partOf. A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of. |
partOf_reference | String | The reference of the partOf. A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of. |
partOf_identifier_value | String | The value of the partOf-identifier. A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of. |
partOf_type | String | The partOf-type of the partOf-type. A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of. |
questionnaire | String | The Questionnaire that defines and organizes the questions for which answers are being provided. |
status | String | The position of the questionnaire response within its overall lifecycle. |
subject_display | String | The display of the subject. The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. |
subject_reference | String | The reference of the subject. The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. |
subject_identifier_value | String | The value of the subject-identifier. The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. |
subject_type | String | The subject-type of the subject-type. The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. |
encounter_display | String | The display of the encounter. The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated. |
encounter_reference | String | The reference of the encounter. The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated. |
encounter_identifier_value | String | The value of the encounter-identifier. The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated. |
encounter_type | String | The encounter-type of the encounter-type. The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated. |
authored | Datetime | The date and/or time that this set of answers were last changed. |
author_display | String | The display of the author. Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. |
author_reference | String | The reference of the author. Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. |
author_identifier_value | String | The value of the author-identifier. Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. |
author_type | String | The author-type of the author-type. Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. |
source_display | String | The display of the source. The person who answered the questions about the subject. |
source_reference | String | The reference of the source. The person who answered the questions about the subject. |
source_identifier_value | String | The value of the source-identifier. The person who answered the questions about the subject. |
source_type | String | The source-type of the source-type. The person who answered the questions about the subject. |
item_id | String | The item-id of the item-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_extension | String | The item-extension of the item-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_modifierExtension | String | The item-modifierExtension of the item-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_linkId | String | The item-linkId of the item-linkId. The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource. |
item_definition | String | The item-definition of the item-definition. A reference to an [ElementDefinition](elementdefinition.html) that provides the details for the item. |
item_text | String | The item-text of the item-text. Text that is displayed above the contents of the group or as the text of the question being answered. |
item_answer_id | String | The item-answer-id of the item-answer-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
item_answer_extension | String | The item-answer-extension of the item-answer-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
item_answer_modifierExtension | String | The item-answer-modifierExtension of the item-answer-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
item_answer_value_x_ | Bool | The item-answer-value[x] of the item-answer-value[x]. The answer (or one of the answers) provided by the respondent to the question. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_author | String | The SP_author search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_item_subject | String | The SP_item_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_based_on | String | The SP_based_on search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_source | String | The SP_source search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_part_of | String | The SP_part_of search parameter. |
SP_filter | String | The SP_filter search parameter. |
RegulatedAuthorization view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifier for the authorization, typically assigned by the authorizing body. |
identifier_use | String | The identifier-use of the identifier-use. Business identifier for the authorization, typically assigned by the authorizing body. |
identifier_type_coding | String | The coding of the identifier-type. Business identifier for the authorization, typically assigned by the authorizing body. |
identifier_type_text | String | The text of the identifier-type. Business identifier for the authorization, typically assigned by the authorizing body. |
identifier_system | String | The identifier-system of the identifier-system. Business identifier for the authorization, typically assigned by the authorizing body. |
identifier_period_start | String | The start of the identifier-period. Business identifier for the authorization, typically assigned by the authorizing body. |
identifier_period_end | String | The end of the identifier-period. Business identifier for the authorization, typically assigned by the authorizing body. |
subject_display | String | The display of the subject. The product type, treatment, facility or activity that is being authorized. |
subject_reference | String | The reference of the subject. The product type, treatment, facility or activity that is being authorized. |
subject_identifier_value | String | The value of the subject-identifier. The product type, treatment, facility or activity that is being authorized. |
subject_type | String | The subject-type of the subject-type. The product type, treatment, facility or activity that is being authorized. |
type_coding | String | The coding of the type. Overall type of this authorization, for example drug marketing approval, orphan drug designation. |
type_text | String | The text of the type. Overall type of this authorization, for example drug marketing approval, orphan drug designation. |
description | String | General textual supporting information. |
region_coding | String | The coding of the region. The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted. |
region_text | String | The text of the region. The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted. |
status_coding | String | The coding of the status. The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications. |
status_text | String | The text of the status. The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications. |
statusDate | Datetime | The date at which the current status was assigned. |
validityPeriod_start | Datetime | The start of the validityPeriod. The time period in which the regulatory approval, clearance or licencing is in effect. As an example, a Marketing Authorization includes the date of authorization and/or an expiration date. |
validityPeriod_end | Datetime | The end of the validityPeriod. The time period in which the regulatory approval, clearance or licencing is in effect. As an example, a Marketing Authorization includes the date of authorization and/or an expiration date. |
indication_display | String | The display of the indication. Condition for which the use of the regulated product applies. |
indication_reference | String | The reference of the indication. Condition for which the use of the regulated product applies. |
indication_identifier_value | String | The value of the indication-identifier. Condition for which the use of the regulated product applies. |
indication_type | String | The indication-type of the indication-type. Condition for which the use of the regulated product applies. |
intendedUse_coding | String | The coding of the intendedUse. The intended use of the product, e.g. prevention, treatment. |
intendedUse_text | String | The text of the intendedUse. The intended use of the product, e.g. prevention, treatment. |
basis_coding | String | The coding of the basis. The legal or regulatory framework against which this authorization is granted, or other reasons for it. |
basis_text | String | The text of the basis. The legal or regulatory framework against which this authorization is granted, or other reasons for it. |
holder_display | String | The display of the holder. The organization that holds the granted authorization. |
holder_reference | String | The reference of the holder. The organization that holds the granted authorization. |
holder_identifier_value | String | The value of the holder-identifier. The organization that holds the granted authorization. |
holder_type | String | The holder-type of the holder-type. The organization that holds the granted authorization. |
regulator_display | String | The display of the regulator. The regulatory authority or authorizing body granting the authorization. For example, European Medicines Agency (EMA), Food and Drug Administration (FDA), Health Canada (HC), etc. |
regulator_reference | String | The reference of the regulator. The regulatory authority or authorizing body granting the authorization. For example, European Medicines Agency (EMA), Food and Drug Administration (FDA), Health Canada (HC), etc. |
regulator_identifier_value | String | The value of the regulator-identifier. The regulatory authority or authorizing body granting the authorization. For example, European Medicines Agency (EMA), Food and Drug Administration (FDA), Health Canada (HC), etc. |
regulator_type | String | The regulator-type of the regulator-type. The regulatory authority or authorizing body granting the authorization. For example, European Medicines Agency (EMA), Food and Drug Administration (FDA), Health Canada (HC), etc. |
case_id | String | The case-id of the case-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
case_extension | String | The case-extension of the case-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
case_modifierExtension | String | The case-modifierExtension of the case-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
case_identifier_value | String | The value of the case-identifier. Identifier by which this case can be referenced. |
case_identifier_use | String | The case-identifier-use of the case-identifier-use. Identifier by which this case can be referenced. |
case_identifier_type_coding | String | The coding of the case-identifier-type. Identifier by which this case can be referenced. |
case_identifier_type_text | String | The text of the case-identifier-type. Identifier by which this case can be referenced. |
case_identifier_system | String | The case-identifier-system of the case-identifier-system. Identifier by which this case can be referenced. |
case_identifier_period_start | Datetime | The start of the case-identifier-period. Identifier by which this case can be referenced. |
case_identifier_period_end | Datetime | The end of the case-identifier-period. Identifier by which this case can be referenced. |
case_type_coding | String | The coding of the case-type. The defining type of case. |
case_type_text | String | The text of the case-type. The defining type of case. |
case_status_coding | String | The coding of the case-status. The status associated with the case. |
case_status_text | String | The text of the case-status. The status associated with the case. |
case_date_x_start | Datetime | The start of the case-date[x]. Relevant date for this of case. |
case_date_x_end | Datetime | The end of the case-date[x]. Relevant date for this of case. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_status_start | String | The SP_status_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_status_end | String | The SP_status_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_holder | String | The SP_holder search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_region_end | String | The SP_region_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_region_start | String | The SP_region_start search parameter. |
SP_case_type_end | String | The SP_case_type_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_case_type_start | String | The SP_case_type_start search parameter. |
SP_case_start | String | The SP_case_start search parameter. |
SP_case_end | String | The SP_case_end search parameter. |
RequestGroup view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Allows a service to provide a unique, business identifier for the request. |
identifier_use | String | The identifier-use of the identifier-use. Allows a service to provide a unique, business identifier for the request. |
identifier_type_coding | String | The coding of the identifier-type. Allows a service to provide a unique, business identifier for the request. |
identifier_type_text | String | The text of the identifier-type. Allows a service to provide a unique, business identifier for the request. |
identifier_system | String | The identifier-system of the identifier-system. Allows a service to provide a unique, business identifier for the request. |
identifier_period_start | String | The start of the identifier-period. Allows a service to provide a unique, business identifier for the request. |
identifier_period_end | String | The end of the identifier-period. Allows a service to provide a unique, business identifier for the request. |
instantiatesCanonical | String | A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. |
instantiatesUri | String | A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. |
basedOn_display | String | The display of the basedOn. A plan, proposal or order that is fulfilled in whole or in part by this request. |
basedOn_reference | String | The reference of the basedOn. A plan, proposal or order that is fulfilled in whole or in part by this request. |
basedOn_identifier_value | String | The value of the basedOn-identifier. A plan, proposal or order that is fulfilled in whole or in part by this request. |
basedOn_type | String | The basedOn-type of the basedOn-type. A plan, proposal or order that is fulfilled in whole or in part by this request. |
replaces_display | String | The display of the replaces. Completed or terminated request(s) whose function is taken by this new request. |
replaces_reference | String | The reference of the replaces. Completed or terminated request(s) whose function is taken by this new request. |
replaces_identifier_value | String | The value of the replaces-identifier. Completed or terminated request(s) whose function is taken by this new request. |
replaces_type | String | The replaces-type of the replaces-type. Completed or terminated request(s) whose function is taken by this new request. |
groupIdentifier_value | String | The value of the groupIdentifier. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
groupIdentifier_use | String | The groupIdentifier-use of the groupIdentifier-use. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
groupIdentifier_type_coding | String | The coding of the groupIdentifier-type. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
groupIdentifier_type_text | String | The text of the groupIdentifier-type. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
groupIdentifier_system | String | The groupIdentifier-system of the groupIdentifier-system. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
groupIdentifier_period_start | Datetime | The start of the groupIdentifier-period. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
groupIdentifier_period_end | Datetime | The end of the groupIdentifier-period. A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
status | String | The current state of the request. For request groups, the status reflects the status of all the requests in the group. |
intent | String | Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. |
priority | String | Indicates how quickly the request should be addressed with respect to other requests. |
code_coding | String | The coding of the code. A code that identifies what the overall request group is. |
code_text | String | The text of the code. A code that identifies what the overall request group is. |
subject_display | String | The display of the subject. The subject for which the request group was created. |
subject_reference | String | The reference of the subject. The subject for which the request group was created. |
subject_identifier_value | String | The value of the subject-identifier. The subject for which the request group was created. |
subject_type | String | The subject-type of the subject-type. The subject for which the request group was created. |
encounter_display | String | The display of the encounter. Describes the context of the request group, if any. |
encounter_reference | String | The reference of the encounter. Describes the context of the request group, if any. |
encounter_identifier_value | String | The value of the encounter-identifier. Describes the context of the request group, if any. |
encounter_type | String | The encounter-type of the encounter-type. Describes the context of the request group, if any. |
authoredOn | Datetime | Indicates when the request group was created. |
author_display | String | The display of the author. Provides a reference to the author of the request group. |
author_reference | String | The reference of the author. Provides a reference to the author of the request group. |
author_identifier_value | String | The value of the author-identifier. Provides a reference to the author of the request group. |
author_type | String | The author-type of the author-type. Provides a reference to the author of the request group. |
reasonCode_coding | String | The coding of the reasonCode. Describes the reason for the request group in coded or textual form. |
reasonCode_text | String | The text of the reasonCode. Describes the reason for the request group in coded or textual form. |
reasonReference_display | String | The display of the reasonReference. Indicates another resource whose existence justifies this request group. |
reasonReference_reference | String | The reference of the reasonReference. Indicates another resource whose existence justifies this request group. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Indicates another resource whose existence justifies this request group. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Indicates another resource whose existence justifies this request group. |
note | String | Provides a mechanism to communicate additional information about the response. |
action_id | String | The action-id of the action-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
action_extension | String | The action-extension of the action-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
action_modifierExtension | String | The action-modifierExtension of the action-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
action_prefix | String | The action-prefix of the action-prefix. A user-visible prefix for the action. |
action_title | String | The action-title of the action-title. The title of the action displayed to a user. |
action_description | String | The action-description of the action-description. A short description of the action used to provide a summary to display to the user. |
action_textEquivalent | String | The action-textEquivalent of the action-textEquivalent. A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically. |
action_priority | String | The action-priority of the action-priority. Indicates how quickly the action should be addressed with respect to other actions. |
action_code_coding | String | The coding of the action-code. A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template. |
action_code_text | String | The text of the action-code. A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template. |
action_documentation | String | The action-documentation of the action-documentation. Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources. |
action_condition_id | String | The action-condition-id of the action-condition-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
action_condition_extension | String | The action-condition-extension of the action-condition-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
action_condition_modifierExtension | String | The action-condition-modifierExtension of the action-condition-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
action_condition_kind | String | The action-condition-kind of the action-condition-kind. The kind of condition. |
action_condition_expression | String | The action-condition-expression of the action-condition-expression. An expression that returns true or false, indicating whether or not the condition is satisfied. |
action_relatedAction_id | String | The action-relatedAction-id of the action-relatedAction-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
action_relatedAction_extension | String | The action-relatedAction-extension of the action-relatedAction-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
action_relatedAction_modifierExtension | String | The action-relatedAction-modifierExtension of the action-relatedAction-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
action_relatedAction_actionId | String | The action-relatedAction-actionId of the action-relatedAction-actionId. The element id of the action this is related to. |
action_relatedAction_relationship | String | The action-relatedAction-relationship of the action-relatedAction-relationship. The relationship of this action to the related action. |
action_relatedAction_offset_x_ | String | The action-relatedAction-offset[x] of the action-relatedAction-offset[x]. A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. |
action_timing_x_ | Datetime | The action-timing[x] of the action-timing[x]. An optional value describing when the action should be performed. |
action_participant_display | String | The display of the action-participant. The participant that should perform or be responsible for this action. |
action_participant_reference | String | The reference of the action-participant. The participant that should perform or be responsible for this action. |
action_participant_identifier_value | String | The value of the action-participant-identifier. The participant that should perform or be responsible for this action. |
action_participant_type | String | The action-participant-type of the action-participant-type. The participant that should perform or be responsible for this action. |
action_type_coding | String | The coding of the action-type. The type of action to perform (create, update, remove). |
action_type_text | String | The text of the action-type. The type of action to perform (create, update, remove). |
action_groupingBehavior | String | The action-groupingBehavior of the action-groupingBehavior. Defines the grouping behavior for the action and its children. |
action_selectionBehavior | String | The action-selectionBehavior of the action-selectionBehavior. Defines the selection behavior for the action and its children. |
action_requiredBehavior | String | The action-requiredBehavior of the action-requiredBehavior. Defines expectations around whether an action is required. |
action_precheckBehavior | String | The action-precheckBehavior of the action-precheckBehavior. Defines whether the action should usually be preselected. |
action_cardinalityBehavior | String | The action-cardinalityBehavior of the action-cardinalityBehavior. Defines whether the action can be selected multiple times. |
action_resource_display | String | The display of the action-resource. The resource that is the target of the action (e.g. CommunicationRequest). |
action_resource_reference | String | The reference of the action-resource. The resource that is the target of the action (e.g. CommunicationRequest). |
action_resource_identifier_value | String | The value of the action-resource-identifier. The resource that is the target of the action (e.g. CommunicationRequest). |
action_resource_type | String | The action-resource-type of the action-resource-type. The resource that is the target of the action (e.g. CommunicationRequest). |
SP_source | String | The SP_source search parameter. |
SP_instantiates_canonical | String | The SP_instantiates_canonical search parameter. |
SP_text | String | The SP_text search parameter. |
SP_authored | String | The SP_authored search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_author | String | The SP_author search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_instantiates_uri | String | The SP_instantiates_uri search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_group_identifier_end | String | The SP_group_identifier_end search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_group_identifier_start | String | The SP_group_identifier_start search parameter. |
SP_participant | String | The SP_participant search parameter. |
SP_filter | String | The SP_filter search parameter. |
ResearchDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers. |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_start | String | The start of the identifier-period. A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_end | String | The end of the identifier-period. A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
version | String | The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. |
name | String | A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
title | String | A short, descriptive, user-friendly title for the research definition. |
shortTitle | String | The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary. |
subtitle | String | An explanatory or alternate title for the ResearchDefinition giving additional information about its content. |
status | String | The status of this research definition. Enables tracking the life-cycle of the content. |
experimental | Bool | A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
subject_x_coding | String | The coding of the subject[x]. The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything. |
subject_x_text | String | The text of the subject[x]. The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything. |
date | Datetime | The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes. |
publisher | String | The name of the organization or individual that published the research definition. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
description | String | A free text natural language description of the research definition from a consumer's perspective. |
comment | String | A human-readable string to clarify or explain concepts about the resource. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research definition instances. |
jurisdiction_coding | String | The coding of the jurisdiction. A legal or geographic region in which the research definition is intended to be used. |
jurisdiction_text | String | The text of the jurisdiction. A legal or geographic region in which the research definition is intended to be used. |
purpose | String | Explanation of why this research definition is needed and why it has been designed as it has. |
usage | String | A detailed description, from a clinical perspective, of how the ResearchDefinition is used. |
copyright | String | A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition. |
approvalDate | Date | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
lastReviewDate | Date | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
effectivePeriod_start | Datetime | The start of the effectivePeriod. The period during which the research definition content was or is planned to be in active use. |
effectivePeriod_end | Datetime | The end of the effectivePeriod. The period during which the research definition content was or is planned to be in active use. |
topic_coding | String | The coding of the topic. Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching. |
topic_text | String | The text of the topic. Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching. |
author | String | An individiual or organization primarily involved in the creation and maintenance of the content. |
editor | String | An individual or organization primarily responsible for internal coherence of the content. |
reviewer | String | An individual or organization primarily responsible for review of some aspect of the content. |
endorser | String | An individual or organization responsible for officially endorsing the content for use in some setting. |
relatedArtifact | String | Related artifacts such as additional documentation, justification, or bibliographic references. |
library | String | A reference to a Library resource containing the formal logic used by the ResearchDefinition. |
population_display | String | The display of the population. A reference to a ResearchElementDefinition resource that defines the population for the research. |
population_reference | String | The reference of the population. A reference to a ResearchElementDefinition resource that defines the population for the research. |
population_identifier_value | String | The value of the population-identifier. A reference to a ResearchElementDefinition resource that defines the population for the research. |
population_type | String | The population-type of the population-type. A reference to a ResearchElementDefinition resource that defines the population for the research. |
exposure_display | String | The display of the exposure. A reference to a ResearchElementDefinition resource that defines the exposure for the research. |
exposure_reference | String | The reference of the exposure. A reference to a ResearchElementDefinition resource that defines the exposure for the research. |
exposure_identifier_value | String | The value of the exposure-identifier. A reference to a ResearchElementDefinition resource that defines the exposure for the research. |
exposure_type | String | The exposure-type of the exposure-type. A reference to a ResearchElementDefinition resource that defines the exposure for the research. |
exposureAlternative_display | String | The display of the exposureAlternative. A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research. |
exposureAlternative_reference | String | The reference of the exposureAlternative. A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research. |
exposureAlternative_identifier_value | String | The value of the exposureAlternative-identifier. A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research. |
exposureAlternative_type | String | The exposureAlternative-type of the exposureAlternative-type. A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research. |
outcome_display | String | The display of the outcome. A reference to a ResearchElementDefinition resomece that defines the outcome for the research. |
outcome_reference | String | The reference of the outcome. A reference to a ResearchElementDefinition resomece that defines the outcome for the research. |
outcome_identifier_value | String | The value of the outcome-identifier. A reference to a ResearchElementDefinition resomece that defines the outcome for the research. |
outcome_type | String | The outcome-type of the outcome-type. A reference to a ResearchElementDefinition resomece that defines the outcome for the research. |
SP_context_end | String | The SP_context_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_depends_on | String | The SP_depends_on search parameter. |
SP_predecessor | String | The SP_predecessor search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_jurisdiction_start | String | The SP_jurisdiction_start search parameter. |
SP_effective | String | The SP_effective search parameter. |
SP_topic_end | String | The SP_topic_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_context_type_start | String | The SP_context_type_start search parameter. |
SP_context_quantity | String | The SP_context_quantity search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_context_type_value | String | The SP_context_type_value search parameter. |
SP_successor | String | The SP_successor search parameter. |
SP_context_type_quantity | String | The SP_context_type_quantity search parameter. |
SP_derived_from | String | The SP_derived_from search parameter. |
SP_context_type_end | String | The SP_context_type_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_context_start | String | The SP_context_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_composed_of | String | The SP_composed_of search parameter. |
SP_jurisdiction_end | String | The SP_jurisdiction_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_topic_start | String | The SP_topic_start search parameter. |
ResearchElementDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URI that is used to identify this research element definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research element definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research element definition is stored on different servers. |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_start | String | The start of the identifier-period. A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_end | String | The end of the identifier-period. A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance. |
version | String | The identifier that is used to identify this version of the research element definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research element definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. |
name | String | A natural language name identifying the research element definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
title | String | A short, descriptive, user-friendly title for the research element definition. |
shortTitle | String | The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary. |
subtitle | String | An explanatory or alternate title for the ResearchElementDefinition giving additional information about its content. |
status | String | The status of this research element definition. Enables tracking the life-cycle of the content. |
experimental | Bool | A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
subject_x_coding | String | The coding of the subject[x]. The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything. |
subject_x_text | String | The text of the subject[x]. The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything. |
date | Datetime | The date (and optionally time) when the research element definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research element definition changes. |
publisher | String | The name of the organization or individual that published the research element definition. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
description | String | A free text natural language description of the research element definition from a consumer's perspective. |
comment | String | A human-readable string to clarify or explain concepts about the resource. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research element definition instances. |
jurisdiction_coding | String | The coding of the jurisdiction. A legal or geographic region in which the research element definition is intended to be used. |
jurisdiction_text | String | The text of the jurisdiction. A legal or geographic region in which the research element definition is intended to be used. |
purpose | String | Explanation of why this research element definition is needed and why it has been designed as it has. |
usage | String | A detailed description, from a clinical perspective, of how the ResearchElementDefinition is used. |
copyright | String | A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definition. |
approvalDate | Date | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
lastReviewDate | Date | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
effectivePeriod_start | Datetime | The start of the effectivePeriod. The period during which the research element definition content was or is planned to be in active use. |
effectivePeriod_end | Datetime | The end of the effectivePeriod. The period during which the research element definition content was or is planned to be in active use. |
topic_coding | String | The coding of the topic. Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching. |
topic_text | String | The text of the topic. Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching. |
author | String | An individiual or organization primarily involved in the creation and maintenance of the content. |
editor | String | An individual or organization primarily responsible for internal coherence of the content. |
reviewer | String | An individual or organization primarily responsible for review of some aspect of the content. |
endorser | String | An individual or organization responsible for officially endorsing the content for use in some setting. |
relatedArtifact | String | Related artifacts such as additional documentation, justification, or bibliographic references. |
library | String | A reference to a Library resource containing the formal logic used by the ResearchElementDefinition. |
type | String | The type of research element, a population, an exposure, or an outcome. |
variableType | String | The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive). |
characteristic_id | String | The characteristic-id of the characteristic-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
characteristic_extension | String | The characteristic-extension of the characteristic-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
characteristic_modifierExtension | String | The characteristic-modifierExtension of the characteristic-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
characteristic_definition_x_coding | String | The coding of the characteristic-definition[x]. Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). |
characteristic_definition_x_text | String | The text of the characteristic-definition[x]. Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). |
characteristic_usageContext | String | The characteristic-usageContext of the characteristic-usageContext. Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings. |
characteristic_exclude | Bool | The characteristic-exclude of the characteristic-exclude. When true, members with this characteristic are excluded from the element. |
characteristic_unitOfMeasure_coding | String | The coding of the characteristic-unitOfMeasure. Specifies the UCUM unit for the outcome. |
characteristic_unitOfMeasure_text | String | The text of the characteristic-unitOfMeasure. Specifies the UCUM unit for the outcome. |
characteristic_studyEffectiveDescription | String | The characteristic-studyEffectiveDescription of the characteristic-studyEffectiveDescription. A narrative description of the time period the study covers. |
characteristic_studyEffective_x_ | Datetime | The characteristic-studyEffective[x] of the characteristic-studyEffective[x]. Indicates what effective period the study covers. |
characteristic_studyEffectiveTimeFromStart | String | The characteristic-studyEffectiveTimeFromStart of the characteristic-studyEffectiveTimeFromStart. Indicates duration from the study initiation. |
characteristic_studyEffectiveGroupMeasure | String | The characteristic-studyEffectiveGroupMeasure of the characteristic-studyEffectiveGroupMeasure. Indicates how elements are aggregated within the study effective period. |
characteristic_participantEffectiveDescription | String | The characteristic-participantEffectiveDescription of the characteristic-participantEffectiveDescription. A narrative description of the time period the study covers. |
characteristic_participantEffective_x_ | Datetime | The characteristic-participantEffective[x] of the characteristic-participantEffective[x]. Indicates what effective period the study covers. |
characteristic_participantEffectiveTimeFromStart | String | The characteristic-participantEffectiveTimeFromStart of the characteristic-participantEffectiveTimeFromStart. Indicates duration from the participant's study entry. |
characteristic_participantEffectiveGroupMeasure | String | The characteristic-participantEffectiveGroupMeasure of the characteristic-participantEffectiveGroupMeasure. Indicates how elements are aggregated within the study effective period. |
SP_context_end | String | The SP_context_end search parameter. |
SP_source | String | The SP_source search parameter. |
SP_depends_on | String | The SP_depends_on search parameter. |
SP_predecessor | String | The SP_predecessor search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_jurisdiction_start | String | The SP_jurisdiction_start search parameter. |
SP_effective | String | The SP_effective search parameter. |
SP_topic_end | String | The SP_topic_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_context_type_start | String | The SP_context_type_start search parameter. |
SP_context_quantity | String | The SP_context_quantity search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_context_type_value | String | The SP_context_type_value search parameter. |
SP_successor | String | The SP_successor search parameter. |
SP_context_type_quantity | String | The SP_context_type_quantity search parameter. |
SP_derived_from | String | The SP_derived_from search parameter. |
SP_context_type_end | String | The SP_context_type_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_context_start | String | The SP_context_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_composed_of | String | The SP_composed_of search parameter. |
SP_jurisdiction_end | String | The SP_jurisdiction_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_topic_start | String | The SP_topic_start search parameter. |
ResearchStudy view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifiers assigned to this research study by the sponsor or other systems. |
identifier_use | String | The identifier-use of the identifier-use. Identifiers assigned to this research study by the sponsor or other systems. |
identifier_type_coding | String | The coding of the identifier-type. Identifiers assigned to this research study by the sponsor or other systems. |
identifier_type_text | String | The text of the identifier-type. Identifiers assigned to this research study by the sponsor or other systems. |
identifier_system | String | The identifier-system of the identifier-system. Identifiers assigned to this research study by the sponsor or other systems. |
identifier_period_start | String | The start of the identifier-period. Identifiers assigned to this research study by the sponsor or other systems. |
identifier_period_end | String | The end of the identifier-period. Identifiers assigned to this research study by the sponsor or other systems. |
title | String | A short, descriptive user-friendly label for the study. |
protocol_display | String | The display of the protocol. The set of steps expected to be performed as part of the execution of the study. |
protocol_reference | String | The reference of the protocol. The set of steps expected to be performed as part of the execution of the study. |
protocol_identifier_value | String | The value of the protocol-identifier. The set of steps expected to be performed as part of the execution of the study. |
protocol_type | String | The protocol-type of the protocol-type. The set of steps expected to be performed as part of the execution of the study. |
partOf_display | String | The display of the partOf. A larger research study of which this particular study is a component or step. |
partOf_reference | String | The reference of the partOf. A larger research study of which this particular study is a component or step. |
partOf_identifier_value | String | The value of the partOf-identifier. A larger research study of which this particular study is a component or step. |
partOf_type | String | The partOf-type of the partOf-type. A larger research study of which this particular study is a component or step. |
status | String | The current state of the study. |
primaryPurposeType_coding | String | The coding of the primaryPurposeType. The type of study based upon the intent of the study's activities. A classification of the intent of the study. |
primaryPurposeType_text | String | The text of the primaryPurposeType. The type of study based upon the intent of the study's activities. A classification of the intent of the study. |
phase_coding | String | The coding of the phase. The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation. |
phase_text | String | The text of the phase. The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation. |
category_coding | String | The coding of the category. Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc. |
category_text | String | The text of the category. Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc. |
focus_coding | String | The coding of the focus. The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about. |
focus_text | String | The text of the focus. The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about. |
condition_coding | String | The coding of the condition. The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion 'healthy volunteer', but the target condition code would be a Lupus SNOMED code. |
condition_text | String | The text of the condition. The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion 'healthy volunteer', but the target condition code would be a Lupus SNOMED code. |
contact | String | Contact details to assist a user in learning more about or engaging with the study. |
relatedArtifact | String | Citations, references and other related documents. |
keyword_coding | String | The coding of the keyword. Key terms to aid in searching for or filtering the study. |
keyword_text | String | The text of the keyword. Key terms to aid in searching for or filtering the study. |
location_coding | String | The coding of the location. Indicates a country, state or other region where the study is taking place. |
location_text | String | The text of the location. Indicates a country, state or other region where the study is taking place. |
description | String | A full description of how the study is being conducted. |
enrollment_display | String | The display of the enrollment. Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. ' 200 female Europeans between the ages of 20 and 45 with early onset diabetes'. |
enrollment_reference | String | The reference of the enrollment. Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. ' 200 female Europeans between the ages of 20 and 45 with early onset diabetes'. |
enrollment_identifier_value | String | The value of the enrollment-identifier. Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. ' 200 female Europeans between the ages of 20 and 45 with early onset diabetes'. |
enrollment_type | String | The enrollment-type of the enrollment-type. Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. ' 200 female Europeans between the ages of 20 and 45 with early onset diabetes'. |
period_start | Datetime | The start of the period. Identifies the start date and the expected (or actual, depending on status) end date for the study. |
period_end | Datetime | The end of the period. Identifies the start date and the expected (or actual, depending on status) end date for the study. |
sponsor_display | String | The display of the sponsor. An organization that initiates the investigation and is legally responsible for the study. |
sponsor_reference | String | The reference of the sponsor. An organization that initiates the investigation and is legally responsible for the study. |
sponsor_identifier_value | String | The value of the sponsor-identifier. An organization that initiates the investigation and is legally responsible for the study. |
sponsor_type | String | The sponsor-type of the sponsor-type. An organization that initiates the investigation and is legally responsible for the study. |
principalInvestigator_display | String | The display of the principalInvestigator. A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation. |
principalInvestigator_reference | String | The reference of the principalInvestigator. A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation. |
principalInvestigator_identifier_value | String | The value of the principalInvestigator-identifier. A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation. |
principalInvestigator_type | String | The principalInvestigator-type of the principalInvestigator-type. A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation. |
site_display | String | The display of the site. A facility in which study activities are conducted. |
site_reference | String | The reference of the site. A facility in which study activities are conducted. |
site_identifier_value | String | The value of the site-identifier. A facility in which study activities are conducted. |
site_type | String | The site-type of the site-type. A facility in which study activities are conducted. |
reasonStopped_coding | String | The coding of the reasonStopped. A description and/or code explaining the premature termination of the study. |
reasonStopped_text | String | The text of the reasonStopped. A description and/or code explaining the premature termination of the study. |
note | String | Comments made about the study by the performer, subject or other participants. |
arm_id | String | The arm-id of the arm-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
arm_extension | String | The arm-extension of the arm-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
arm_modifierExtension | String | The arm-modifierExtension of the arm-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
arm_name | String | The arm-name of the arm-name. Unique, human-readable label for this arm of the study. |
arm_type_coding | String | The coding of the arm-type. Categorization of study arm, e.g. experimental, active comparator, placebo comparater. |
arm_type_text | String | The text of the arm-type. Categorization of study arm, e.g. experimental, active comparator, placebo comparater. |
arm_description | String | The arm-description of the arm-description. A succinct description of the path through the study that would be followed by a subject adhering to this arm. |
objective_id | String | The objective-id of the objective-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
objective_extension | String | The objective-extension of the objective-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
objective_modifierExtension | String | The objective-modifierExtension of the objective-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
objective_name | String | The objective-name of the objective-name. Unique, human-readable label for this objective of the study. |
objective_type_coding | String | The coding of the objective-type. The kind of study objective. |
objective_type_text | String | The text of the objective-type. The kind of study objective. |
SP_focus_start | String | The SP_focus_start search parameter. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_sponsor | String | The SP_sponsor search parameter. |
SP_principalinvestigator | String | The SP_principalinvestigator search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_location_start | String | The SP_location_start search parameter. |
SP_keyword_start | String | The SP_keyword_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_partof | String | The SP_partof search parameter. |
SP_list | String | The SP_list search parameter. |
SP_location_end | String | The SP_location_end search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_site | String | The SP_site search parameter. |
SP_protocol | String | The SP_protocol search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_focus_end | String | The SP_focus_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_keyword_end | String | The SP_keyword_end search parameter. |
SP_date | String | The SP_date search parameter. |
ResearchSubject view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifiers assigned to this research subject for a study. |
identifier_use | String | The identifier-use of the identifier-use. Identifiers assigned to this research subject for a study. |
identifier_type_coding | String | The coding of the identifier-type. Identifiers assigned to this research subject for a study. |
identifier_type_text | String | The text of the identifier-type. Identifiers assigned to this research subject for a study. |
identifier_system | String | The identifier-system of the identifier-system. Identifiers assigned to this research subject for a study. |
identifier_period_start | String | The start of the identifier-period. Identifiers assigned to this research subject for a study. |
identifier_period_end | String | The end of the identifier-period. Identifiers assigned to this research subject for a study. |
status | String | The current state of the subject. |
period_start | Datetime | The start of the period. The dates the subject began and ended their participation in the study. |
period_end | Datetime | The end of the period. The dates the subject began and ended their participation in the study. |
study_display | String | The display of the study. Reference to the study the subject is participating in. |
study_reference | String | The reference of the study. Reference to the study the subject is participating in. |
study_identifier_value | String | The value of the study-identifier. Reference to the study the subject is participating in. |
study_type | String | The study-type of the study-type. Reference to the study the subject is participating in. |
individual_display | String | The display of the individual. The record of the person or animal who is involved in the study. |
individual_reference | String | The reference of the individual. The record of the person or animal who is involved in the study. |
individual_identifier_value | String | The value of the individual-identifier. The record of the person or animal who is involved in the study. |
individual_type | String | The individual-type of the individual-type. The record of the person or animal who is involved in the study. |
assignedArm | String | The name of the arm in the study the subject is expected to follow as part of this study. |
actualArm | String | The name of the arm in the study the subject actually followed as part of this study. |
consent_display | String | The display of the consent. A record of the patient's informed agreement to participate in the study. |
consent_reference | String | The reference of the consent. A record of the patient's informed agreement to participate in the study. |
consent_identifier_value | String | The value of the consent-identifier. A record of the patient's informed agreement to participate in the study. |
consent_type | String | The consent-type of the consent-type. A record of the patient's informed agreement to participate in the study. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_study | String | The SP_study search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_date | String | The SP_date search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_individual | String | The SP_individual search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
RiskAssessment view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifier assigned to the risk assessment. |
identifier_use | String | The identifier-use of the identifier-use. Business identifier assigned to the risk assessment. |
identifier_type_coding | String | The coding of the identifier-type. Business identifier assigned to the risk assessment. |
identifier_type_text | String | The text of the identifier-type. Business identifier assigned to the risk assessment. |
identifier_system | String | The identifier-system of the identifier-system. Business identifier assigned to the risk assessment. |
identifier_period_start | String | The start of the identifier-period. Business identifier assigned to the risk assessment. |
identifier_period_end | String | The end of the identifier-period. Business identifier assigned to the risk assessment. |
basedOn_display | String | The display of the basedOn. A reference to the request that is fulfilled by this risk assessment. |
basedOn_reference | String | The reference of the basedOn. A reference to the request that is fulfilled by this risk assessment. |
basedOn_identifier_value | String | The value of the basedOn-identifier. A reference to the request that is fulfilled by this risk assessment. |
basedOn_type | String | The basedOn-type of the basedOn-type. A reference to the request that is fulfilled by this risk assessment. |
parent_display | String | The display of the parent. A reference to a resource that this risk assessment is part of, such as a Procedure. |
parent_reference | String | The reference of the parent. A reference to a resource that this risk assessment is part of, such as a Procedure. |
parent_identifier_value | String | The value of the parent-identifier. A reference to a resource that this risk assessment is part of, such as a Procedure. |
parent_type | String | The parent-type of the parent-type. A reference to a resource that this risk assessment is part of, such as a Procedure. |
status | String | The status of the RiskAssessment, using the same statuses as an Observation. |
method_coding | String | The coding of the method. The algorithm, process or mechanism used to evaluate the risk. |
method_text | String | The text of the method. The algorithm, process or mechanism used to evaluate the risk. |
code_coding | String | The coding of the code. The type of the risk assessment performed. |
code_text | String | The text of the code. The type of the risk assessment performed. |
subject_display | String | The display of the subject. The patient or group the risk assessment applies to. |
subject_reference | String | The reference of the subject. The patient or group the risk assessment applies to. |
subject_identifier_value | String | The value of the subject-identifier. The patient or group the risk assessment applies to. |
subject_type | String | The subject-type of the subject-type. The patient or group the risk assessment applies to. |
encounter_display | String | The display of the encounter. The encounter where the assessment was performed. |
encounter_reference | String | The reference of the encounter. The encounter where the assessment was performed. |
encounter_identifier_value | String | The value of the encounter-identifier. The encounter where the assessment was performed. |
encounter_type | String | The encounter-type of the encounter-type. The encounter where the assessment was performed. |
occurrence_x_ | Datetime | The date (and possibly time) the risk assessment was performed. |
condition_display | String | The display of the condition. For assessments or prognosis specific to a particular condition, indicates the condition being assessed. |
condition_reference | String | The reference of the condition. For assessments or prognosis specific to a particular condition, indicates the condition being assessed. |
condition_identifier_value | String | The value of the condition-identifier. For assessments or prognosis specific to a particular condition, indicates the condition being assessed. |
condition_type | String | The condition-type of the condition-type. For assessments or prognosis specific to a particular condition, indicates the condition being assessed. |
performer_display | String | The display of the performer. The provider or software application that performed the assessment. |
performer_reference | String | The reference of the performer. The provider or software application that performed the assessment. |
performer_identifier_value | String | The value of the performer-identifier. The provider or software application that performed the assessment. |
performer_type | String | The performer-type of the performer-type. The provider or software application that performed the assessment. |
reasonCode_coding | String | The coding of the reasonCode. The reason the risk assessment was performed. |
reasonCode_text | String | The text of the reasonCode. The reason the risk assessment was performed. |
reasonReference_display | String | The display of the reasonReference. Resources supporting the reason the risk assessment was performed. |
reasonReference_reference | String | The reference of the reasonReference. Resources supporting the reason the risk assessment was performed. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Resources supporting the reason the risk assessment was performed. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Resources supporting the reason the risk assessment was performed. |
basis_display | String | The display of the basis. Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.). |
basis_reference | String | The reference of the basis. Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.). |
basis_identifier_value | String | The value of the basis-identifier. Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.). |
basis_type | String | The basis-type of the basis-type. Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.). |
prediction_id | String | The prediction-id of the prediction-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
prediction_extension | String | The prediction-extension of the prediction-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
prediction_modifierExtension | String | The prediction-modifierExtension of the prediction-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
prediction_outcome_coding | String | The coding of the prediction-outcome. One of the potential outcomes for the patient (e.g. remission, death, a particular condition). |
prediction_outcome_text | String | The text of the prediction-outcome. One of the potential outcomes for the patient (e.g. remission, death, a particular condition). |
prediction_probability_x_ | Decimal | The prediction-probability[x] of the prediction-probability[x]. Indicates how likely the outcome is (in the specified timeframe). |
prediction_qualitativeRisk_coding | String | The coding of the prediction-qualitativeRisk. Indicates how likely the outcome is (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, or high). |
prediction_qualitativeRisk_text | String | The text of the prediction-qualitativeRisk. Indicates how likely the outcome is (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, or high). |
prediction_relativeRisk | Decimal | The prediction-relativeRisk of the prediction-relativeRisk. Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.). |
prediction_when_x_start | Datetime | The start of the prediction-when[x]. Indicates the period of time or age range of the subject to which the specified probability applies. |
prediction_when_x_end | Datetime | The end of the prediction-when[x]. Indicates the period of time or age range of the subject to which the specified probability applies. |
prediction_rationale | String | The prediction-rationale of the prediction-rationale. Additional information explaining the basis for the prediction. |
mitigation | String | A description of the steps that might be taken to reduce the identified risk(s). |
note | String | Additional comments about the risk assessment. |
SP_source | String | The SP_source search parameter. |
SP_performer | String | The SP_performer search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_method_start | String | The SP_method_start search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_probability | String | The SP_probability search parameter. |
SP_method_end | String | The SP_method_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_risk_end | String | The SP_risk_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_condition | String | The SP_condition search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_date | String | The SP_date search parameter. |
SP_risk_start | String | The SP_risk_start search parameter. |
Schedule view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. External Ids for this item. |
identifier_use | String | The identifier-use of the identifier-use. External Ids for this item. |
identifier_type_coding | String | The coding of the identifier-type. External Ids for this item. |
identifier_type_text | String | The text of the identifier-type. External Ids for this item. |
identifier_system | String | The identifier-system of the identifier-system. External Ids for this item. |
identifier_period_start | String | The start of the identifier-period. External Ids for this item. |
identifier_period_end | String | The end of the identifier-period. External Ids for this item. |
active | Bool | Whether this schedule record is in active use or should not be used (such as was entered in error). |
serviceCategory_coding | String | The coding of the serviceCategory. A broad categorization of the service that is to be performed during this appointment. |
serviceCategory_text | String | The text of the serviceCategory. A broad categorization of the service that is to be performed during this appointment. |
serviceType_coding | String | The coding of the serviceType. The specific service that is to be performed during this appointment. |
serviceType_text | String | The text of the serviceType. The specific service that is to be performed during this appointment. |
specialty_coding | String | The coding of the specialty. The specialty of a practitioner that would be required to perform the service requested in this appointment. |
specialty_text | String | The text of the specialty. The specialty of a practitioner that would be required to perform the service requested in this appointment. |
actor_display | String | The display of the actor. Slots that reference this schedule resource provide the availability details to these referenced resource(s). |
actor_reference | String | The reference of the actor. Slots that reference this schedule resource provide the availability details to these referenced resource(s). |
actor_identifier_value | String | The value of the actor-identifier. Slots that reference this schedule resource provide the availability details to these referenced resource(s). |
actor_type | String | The actor-type of the actor-type. Slots that reference this schedule resource provide the availability details to these referenced resource(s). |
planningHorizon_start | Datetime | The start of the planningHorizon. The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a 'template' for planning outside these dates. |
planningHorizon_end | Datetime | The end of the planningHorizon. The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a 'template' for planning outside these dates. |
comment | String | Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated. |
SP_source | String | The SP_source search parameter. |
SP_actor | String | The SP_actor search parameter. |
SP_text | String | The SP_text search parameter. |
SP_service_category_end | String | The SP_service_category_end search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_specialty_end | String | The SP_specialty_end search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_service_category_start | String | The SP_service_category_start search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_specialty_start | String | The SP_specialty_start search parameter. |
SP_service_type_start | String | The SP_service_type_start search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_service_type_end | String | The SP_service_type_end search parameter. |
SP_date | String | The SP_date search parameter. |
ServiceRequest view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
identifier_use | String | The identifier-use of the identifier-use. Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
identifier_type_coding | String | The coding of the identifier-type. Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
identifier_type_text | String | The text of the identifier-type. Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
identifier_system | String | The identifier-system of the identifier-system. Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
identifier_period_start | String | The start of the identifier-period. Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
identifier_period_end | String | The end of the identifier-period. Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
instantiatesCanonical | String | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
instantiatesUri | String | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
basedOn_display | String | The display of the basedOn. Plan/proposal/order fulfilled by this request. |
basedOn_reference | String | The reference of the basedOn. Plan/proposal/order fulfilled by this request. |
basedOn_identifier_value | String | The value of the basedOn-identifier. Plan/proposal/order fulfilled by this request. |
basedOn_type | String | The basedOn-type of the basedOn-type. Plan/proposal/order fulfilled by this request. |
replaces_display | String | The display of the replaces. The request takes the place of the referenced completed or terminated request(s). |
replaces_reference | String | The reference of the replaces. The request takes the place of the referenced completed or terminated request(s). |
replaces_identifier_value | String | The value of the replaces-identifier. The request takes the place of the referenced completed or terminated request(s). |
replaces_type | String | The replaces-type of the replaces-type. The request takes the place of the referenced completed or terminated request(s). |
requisition_value | String | The value of the requisition. A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. |
requisition_use | String | The requisition-use of the requisition-use. A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. |
requisition_type_coding | String | The coding of the requisition-type. A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. |
requisition_type_text | String | The text of the requisition-type. A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. |
requisition_system | String | The requisition-system of the requisition-system. A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. |
requisition_period_start | Datetime | The start of the requisition-period. A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. |
requisition_period_end | Datetime | The end of the requisition-period. A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. |
status | String | The status of the order. |
intent | String | Whether the request is a proposal, plan, an original order or a reflex order. |
category_coding | String | The coding of the category. A code that classifies the service for searching, sorting and display purposes (e.g. 'Surgical Procedure'). |
category_text | String | The text of the category. A code that classifies the service for searching, sorting and display purposes (e.g. 'Surgical Procedure'). |
priority | String | Indicates how quickly the ServiceRequest should be addressed with respect to other requests. |
doNotPerform | Bool | Set this to true if the record is saying that the service/procedure should NOT be performed. |
code_coding | String | The coding of the code. A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested. |
code_text | String | The text of the code. A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested. |
orderDetail_coding | String | The coding of the orderDetail. Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied. |
orderDetail_text | String | The text of the orderDetail. Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied. |
quantity_x_value | Decimal | The value of the quantity[x]. An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction). |
quantity_x_unit | String | The unit of the quantity[x]. An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction). |
quantity_x_system | String | The system of the quantity[x]. An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction). |
quantity_x_comparator | String | The quantity[x]-comparator of the quantity[x]-comparator. An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction). |
quantity_x_code | String | The quantity[x]-code of the quantity[x]-code. An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction). |
subject_display | String | The display of the subject. On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). |
subject_reference | String | The reference of the subject. On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). |
subject_identifier_value | String | The value of the subject-identifier. On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). |
subject_type | String | The subject-type of the subject-type. On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). |
encounter_display | String | The display of the encounter. An encounter that provides additional information about the healthcare context in which this request is made. |
encounter_reference | String | The reference of the encounter. An encounter that provides additional information about the healthcare context in which this request is made. |
encounter_identifier_value | String | The value of the encounter-identifier. An encounter that provides additional information about the healthcare context in which this request is made. |
encounter_type | String | The encounter-type of the encounter-type. An encounter that provides additional information about the healthcare context in which this request is made. |
occurrence_x_ | Datetime | The date/time at which the requested service should occur. |
asNeeded_x_ | Bool | If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example 'pain', 'on flare-up', etc. |
authoredOn | Datetime | When the request transitioned to being actionable. |
requester_display | String | The display of the requester. The individual who initiated the request and has responsibility for its activation. |
requester_reference | String | The reference of the requester. The individual who initiated the request and has responsibility for its activation. |
requester_identifier_value | String | The value of the requester-identifier. The individual who initiated the request and has responsibility for its activation. |
requester_type | String | The requester-type of the requester-type. The individual who initiated the request and has responsibility for its activation. |
performerType_coding | String | The coding of the performerType. Desired type of performer for doing the requested service. |
performerType_text | String | The text of the performerType. Desired type of performer for doing the requested service. |
performer_display | String | The display of the performer. The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. |
performer_reference | String | The reference of the performer. The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. |
performer_identifier_value | String | The value of the performer-identifier. The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. |
performer_type | String | The performer-type of the performer-type. The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. |
locationCode_coding | String | The coding of the locationCode. The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center. |
locationCode_text | String | The text of the locationCode. The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center. |
locationReference_display | String | The display of the locationReference. A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. |
locationReference_reference | String | The reference of the locationReference. A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. |
locationReference_identifier_value | String | The value of the locationReference-identifier. A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. |
locationReference_type | String | The locationReference-type of the locationReference-type. A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. |
reasonCode_coding | String | The coding of the reasonCode. An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`. |
reasonCode_text | String | The text of the reasonCode. An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`. |
reasonReference_display | String | The display of the reasonReference. Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`. |
reasonReference_reference | String | The reference of the reasonReference. Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`. |
insurance_display | String | The display of the insurance. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. |
insurance_reference | String | The reference of the insurance. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. |
insurance_identifier_value | String | The value of the insurance-identifier. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. |
insurance_type | String | The insurance-type of the insurance-type. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. |
supportingInfo_display | String | The display of the supportingInfo. Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as 'ask at order entry questions (AOEs)'. This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. |
supportingInfo_reference | String | The reference of the supportingInfo. Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as 'ask at order entry questions (AOEs)'. This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. |
supportingInfo_identifier_value | String | The value of the supportingInfo-identifier. Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as 'ask at order entry questions (AOEs)'. This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. |
supportingInfo_type | String | The supportingInfo-type of the supportingInfo-type. Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as 'ask at order entry questions (AOEs)'. This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. |
specimen_display | String | The display of the specimen. One or more specimens that the laboratory procedure will use. |
specimen_reference | String | The reference of the specimen. One or more specimens that the laboratory procedure will use. |
specimen_identifier_value | String | The value of the specimen-identifier. One or more specimens that the laboratory procedure will use. |
specimen_type | String | The specimen-type of the specimen-type. One or more specimens that the laboratory procedure will use. |
bodySite_coding | String | The coding of the bodySite. Anatomic location where the procedure should be performed. This is the target site. |
bodySite_text | String | The text of the bodySite. Anatomic location where the procedure should be performed. This is the target site. |
note | String | Any other notes and comments made about the service request. For example, internal billing notes. |
patientInstruction | String | Instructions in terms that are understood by the patient or consumer. |
relevantHistory_display | String | The display of the relevantHistory. Key events in the history of the request. |
relevantHistory_reference | String | The reference of the relevantHistory. Key events in the history of the request. |
relevantHistory_identifier_value | String | The value of the relevantHistory-identifier. Key events in the history of the request. |
relevantHistory_type | String | The relevantHistory-type of the relevantHistory-type. Key events in the history of the request. |
SP_source | String | The SP_source search parameter. |
SP_specimen | String | The SP_specimen search parameter. |
SP_performer | String | The SP_performer search parameter. |
SP_instantiates_canonical | String | The SP_instantiates_canonical search parameter. |
SP_requisition_end | String | The SP_requisition_end search parameter. |
SP_text | String | The SP_text search parameter. |
SP_authored | String | The SP_authored search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_occurrence | String | The SP_occurrence search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_instantiates_uri | String | The SP_instantiates_uri search parameter. |
SP_based_on | String | The SP_based_on search parameter. |
SP_body_site_end | String | The SP_body_site_end search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_requisition_start | String | The SP_requisition_start search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_body_site_start | String | The SP_body_site_start search parameter. |
SP_requester | String | The SP_requester search parameter. |
SP_replaces | String | The SP_replaces search parameter. |
Slot view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. External Ids for this item. |
identifier_use | String | The identifier-use of the identifier-use. External Ids for this item. |
identifier_type_coding | String | The coding of the identifier-type. External Ids for this item. |
identifier_type_text | String | The text of the identifier-type. External Ids for this item. |
identifier_system | String | The identifier-system of the identifier-system. External Ids for this item. |
identifier_period_start | String | The start of the identifier-period. External Ids for this item. |
identifier_period_end | String | The end of the identifier-period. External Ids for this item. |
serviceCategory_coding | String | The coding of the serviceCategory. A broad categorization of the service that is to be performed during this appointment. |
serviceCategory_text | String | The text of the serviceCategory. A broad categorization of the service that is to be performed during this appointment. |
serviceType_coding | String | The coding of the serviceType. The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource. |
serviceType_text | String | The text of the serviceType. The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource. |
specialty_coding | String | The coding of the specialty. The specialty of a practitioner that would be required to perform the service requested in this appointment. |
specialty_text | String | The text of the specialty. The specialty of a practitioner that would be required to perform the service requested in this appointment. |
appointmentType_coding | String | The coding of the appointmentType. The style of appointment or patient that may be booked in the slot (not service type). |
appointmentType_text | String | The text of the appointmentType. The style of appointment or patient that may be booked in the slot (not service type). |
schedule_display | String | The display of the schedule. The schedule resource that this slot defines an interval of status information. |
schedule_reference | String | The reference of the schedule. The schedule resource that this slot defines an interval of status information. |
schedule_identifier_value | String | The value of the schedule-identifier. The schedule resource that this slot defines an interval of status information. |
schedule_type | String | The schedule-type of the schedule-type. The schedule resource that this slot defines an interval of status information. |
status | String | busy | free | busy-unavailable | busy-tentative | entered-in-error. |
start | String | Date/Time that the slot is to begin. |
end | String | Date/Time that the slot is to conclude. |
overbooked | Bool | This slot has already been overbooked, appointments are unlikely to be accepted for this time. |
comment | String | Comments on the slot to describe any extended information. Such as custom constraints on the slot. |
SP_source | String | The SP_source search parameter. |
SP_appointment_type_end | String | The SP_appointment_type_end search parameter. |
SP_text | String | The SP_text search parameter. |
SP_service_category_end | String | The SP_service_category_end search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_specialty_end | String | The SP_specialty_end search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_service_category_start | String | The SP_service_category_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_specialty_start | String | The SP_specialty_start search parameter. |
SP_service_type_start | String | The SP_service_type_start search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_appointment_type_start | String | The SP_appointment_type_start search parameter. |
SP_schedule | String | The SP_schedule search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_service_type_end | String | The SP_service_type_end search parameter. |
Specimen view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Id for specimen. |
identifier_use | String | The identifier-use of the identifier-use. Id for specimen. |
identifier_type_coding | String | The coding of the identifier-type. Id for specimen. |
identifier_type_text | String | The text of the identifier-type. Id for specimen. |
identifier_system | String | The identifier-system of the identifier-system. Id for specimen. |
identifier_period_start | String | The start of the identifier-period. Id for specimen. |
identifier_period_end | String | The end of the identifier-period. Id for specimen. |
accessionIdentifier_value | String | The value of the accessionIdentifier. The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. |
accessionIdentifier_use | String | The accessionIdentifier-use of the accessionIdentifier-use. The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. |
accessionIdentifier_type_coding | String | The coding of the accessionIdentifier-type. The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. |
accessionIdentifier_type_text | String | The text of the accessionIdentifier-type. The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. |
accessionIdentifier_system | String | The accessionIdentifier-system of the accessionIdentifier-system. The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. |
accessionIdentifier_period_start | Datetime | The start of the accessionIdentifier-period. The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. |
accessionIdentifier_period_end | Datetime | The end of the accessionIdentifier-period. The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. |
status | String | The availability of the specimen. |
type_coding | String | The coding of the type. The kind of material that forms the specimen. |
type_text | String | The text of the type. The kind of material that forms the specimen. |
subject_display | String | The display of the subject. Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device. |
subject_reference | String | The reference of the subject. Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device. |
subject_identifier_value | String | The value of the subject-identifier. Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device. |
subject_type | String | The subject-type of the subject-type. Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device. |
receivedTime | Datetime | Time when specimen was received for processing or testing. |
parent_display | String | The display of the parent. Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. |
parent_reference | String | The reference of the parent. Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. |
parent_identifier_value | String | The value of the parent-identifier. Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. |
parent_type | String | The parent-type of the parent-type. Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. |
request_display | String | The display of the request. Details concerning a service request that required a specimen to be collected. |
request_reference | String | The reference of the request. Details concerning a service request that required a specimen to be collected. |
request_identifier_value | String | The value of the request-identifier. Details concerning a service request that required a specimen to be collected. |
request_type | String | The request-type of the request-type. Details concerning a service request that required a specimen to be collected. |
collection_id | String | The collection-id of the collection-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
collection_extension | String | The collection-extension of the collection-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
collection_modifierExtension | String | The collection-modifierExtension of the collection-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
collection_collector_display | String | The display of the collection-collector. Person who collected the specimen. |
collection_collector_reference | String | The reference of the collection-collector. Person who collected the specimen. |
collection_collector_identifier_value | String | The value of the collection-collector-identifier. Person who collected the specimen. |
collection_collector_type | String | The collection-collector-type of the collection-collector-type. Person who collected the specimen. |
collection_collected_x_ | Datetime | The collection-collected[x] of the collection-collected[x]. Time when specimen was collected from subject - the physiologically relevant time. |
collection_duration | String | The collection-duration of the collection-duration. The span of time over which the collection of a specimen occurred. |
collection_quantity_value | Decimal | The value of the collection-quantity. The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. |
collection_quantity_unit | String | The unit of the collection-quantity. The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. |
collection_quantity_system | String | The system of the collection-quantity. The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. |
collection_quantity_comparator | String | The collection-quantity-comparator of the collection-quantity-comparator. The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. |
collection_quantity_code | String | The collection-quantity-code of the collection-quantity-code. The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. |
collection_method_coding | String | The coding of the collection-method. A coded value specifying the technique that is used to perform the procedure. |
collection_method_text | String | The text of the collection-method. A coded value specifying the technique that is used to perform the procedure. |
collection_bodySite_coding | String | The coding of the collection-bodySite. Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens. |
collection_bodySite_text | String | The text of the collection-bodySite. Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens. |
collection_fastingStatus_x_coding | String | The coding of the collection-fastingStatus[x]. Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection. |
collection_fastingStatus_x_text | String | The text of the collection-fastingStatus[x]. Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection. |
processing_id | String | The processing-id of the processing-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
processing_extension | String | The processing-extension of the processing-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
processing_modifierExtension | String | The processing-modifierExtension of the processing-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
processing_description | String | The processing-description of the processing-description. Textual description of procedure. |
processing_procedure_coding | String | The coding of the processing-procedure. A coded value specifying the procedure used to process the specimen. |
processing_procedure_text | String | The text of the processing-procedure. A coded value specifying the procedure used to process the specimen. |
processing_additive_display | String | The display of the processing-additive. Material used in the processing step. |
processing_additive_reference | String | The reference of the processing-additive. Material used in the processing step. |
processing_additive_identifier_value | String | The value of the processing-additive-identifier. Material used in the processing step. |
processing_additive_type | String | The processing-additive-type of the processing-additive-type. Material used in the processing step. |
processing_time_x_ | Datetime | The processing-time[x] of the processing-time[x]. A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin. |
container_id | String | The container-id of the container-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
container_extension | String | The container-extension of the container-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
container_modifierExtension | String | The container-modifierExtension of the container-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
container_identifier_value | String | The value of the container-identifier. Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances. |
container_identifier_use | String | The container-identifier-use of the container-identifier-use. Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances. |
container_identifier_type_coding | String | The coding of the container-identifier-type. Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances. |
container_identifier_type_text | String | The text of the container-identifier-type. Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances. |
container_identifier_system | String | The container-identifier-system of the container-identifier-system. Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances. |
container_identifier_period_start | String | The start of the container-identifier-period. Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances. |
container_identifier_period_end | String | The end of the container-identifier-period. Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances. |
container_description | String | The container-description of the container-description. Textual description of the container. |
container_type_coding | String | The coding of the container-type. The type of container associated with the specimen (e.g. slide, aliquot, etc.). |
container_type_text | String | The text of the container-type. The type of container associated with the specimen (e.g. slide, aliquot, etc.). |
container_capacity_value | Decimal | The value of the container-capacity. The capacity (volume or other measure) the container may contain. |
container_capacity_unit | String | The unit of the container-capacity. The capacity (volume or other measure) the container may contain. |
container_capacity_system | String | The system of the container-capacity. The capacity (volume or other measure) the container may contain. |
container_capacity_comparator | String | The container-capacity-comparator of the container-capacity-comparator. The capacity (volume or other measure) the container may contain. |
container_capacity_code | String | The container-capacity-code of the container-capacity-code. The capacity (volume or other measure) the container may contain. |
container_specimenQuantity_value | Decimal | The value of the container-specimenQuantity. The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. |
container_specimenQuantity_unit | String | The unit of the container-specimenQuantity. The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. |
container_specimenQuantity_system | String | The system of the container-specimenQuantity. The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. |
container_specimenQuantity_comparator | String | The container-specimenQuantity-comparator of the container-specimenQuantity-comparator. The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. |
container_specimenQuantity_code | String | The container-specimenQuantity-code of the container-specimenQuantity-code. The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. |
container_additive_x_coding | String | The coding of the container-additive[x]. Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. |
container_additive_x_text | String | The text of the container-additive[x]. Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. |
condition_coding | String | The coding of the condition. A mode or state of being that describes the nature of the specimen. |
condition_text | String | The text of the condition. A mode or state of being that describes the nature of the specimen. |
note | String | To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen). |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_container_end | String | The SP_container_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_bodysite_end | String | The SP_bodysite_end search parameter. |
SP_collected | String | The SP_collected search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_parent | String | The SP_parent search parameter. |
SP_collector | String | The SP_collector search parameter. |
SP_list | String | The SP_list search parameter. |
SP_accession_start | String | The SP_accession_start search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_container_start | String | The SP_container_start search parameter. |
SP_accession_end | String | The SP_accession_end search parameter. |
SP_bodysite_start | String | The SP_bodysite_start search parameter. |
SpecimenDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A business identifier associated with the kind of specimen. |
identifier_use | String | The identifier-use of the identifier-use. A business identifier associated with the kind of specimen. |
identifier_type_coding | String | The coding of the identifier-type. A business identifier associated with the kind of specimen. |
identifier_type_text | String | The text of the identifier-type. A business identifier associated with the kind of specimen. |
identifier_system | String | The identifier-system of the identifier-system. A business identifier associated with the kind of specimen. |
identifier_period_start | Datetime | The start of the identifier-period. A business identifier associated with the kind of specimen. |
identifier_period_end | Datetime | The end of the identifier-period. A business identifier associated with the kind of specimen. |
typeCollected_coding | String | The coding of the typeCollected. The kind of material to be collected. |
typeCollected_text | String | The text of the typeCollected. The kind of material to be collected. |
patientPreparation_coding | String | The coding of the patientPreparation. Preparation of the patient for specimen collection. |
patientPreparation_text | String | The text of the patientPreparation. Preparation of the patient for specimen collection. |
timeAspect | String | Time aspect of specimen collection (duration or offset). |
collection_coding | String | The coding of the collection. The action to be performed for collecting the specimen. |
collection_text | String | The text of the collection. The action to be performed for collecting the specimen. |
typeTested_id | String | The typeTested-id of the typeTested-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
typeTested_extension | String | The typeTested-extension of the typeTested-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
typeTested_modifierExtension | String | The typeTested-modifierExtension of the typeTested-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
typeTested_isDerived | Bool | The typeTested-isDerived of the typeTested-isDerived. Primary of secondary specimen. |
typeTested_type_coding | String | The coding of the typeTested-type. The kind of specimen conditioned for testing expected by lab. |
typeTested_type_text | String | The text of the typeTested-type. The kind of specimen conditioned for testing expected by lab. |
typeTested_preference | String | The typeTested-preference of the typeTested-preference. The preference for this type of conditioned specimen. |
typeTested_container_id | String | The typeTested-container-id of the typeTested-container-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
typeTested_container_extension | String | The typeTested-container-extension of the typeTested-container-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
typeTested_container_modifierExtension | String | The typeTested-container-modifierExtension of the typeTested-container-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
typeTested_container_material_coding | String | The coding of the typeTested-container-material. The type of material of the container. |
typeTested_container_material_text | String | The text of the typeTested-container-material. The type of material of the container. |
typeTested_container_type_coding | String | The coding of the typeTested-container-type. The type of container used to contain this kind of specimen. |
typeTested_container_type_text | String | The text of the typeTested-container-type. The type of container used to contain this kind of specimen. |
typeTested_container_cap_coding | String | The coding of the typeTested-container-cap. Color of container cap. |
typeTested_container_cap_text | String | The text of the typeTested-container-cap. Color of container cap. |
typeTested_container_description | String | The typeTested-container-description of the typeTested-container-description. The textual description of the kind of container. |
typeTested_container_capacity_value | Decimal | The value of the typeTested-container-capacity. The capacity (volume or other measure) of this kind of container. |
typeTested_container_capacity_unit | String | The unit of the typeTested-container-capacity. The capacity (volume or other measure) of this kind of container. |
typeTested_container_capacity_system | String | The system of the typeTested-container-capacity. The capacity (volume or other measure) of this kind of container. |
typeTested_container_capacity_comparator | String | The typeTested-container-capacity-comparator of the typeTested-container-capacity-comparator. The capacity (volume or other measure) of this kind of container. |
typeTested_container_capacity_code | String | The typeTested-container-capacity-code of the typeTested-container-capacity-code. The capacity (volume or other measure) of this kind of container. |
typeTested_container_minimumVolume_x_value | Decimal | The value of the typeTested-container-minimumVolume[x]. The minimum volume to be conditioned in the container. |
typeTested_container_minimumVolume_x_unit | String | The unit of the typeTested-container-minimumVolume[x]. The minimum volume to be conditioned in the container. |
typeTested_container_minimumVolume_x_system | String | The system of the typeTested-container-minimumVolume[x]. The minimum volume to be conditioned in the container. |
typeTested_container_minimumVolume_x_comparator | String | The typeTested-container-minimumVolume[x]-comparator of the typeTested-container-minimumVolume[x]-comparator. The minimum volume to be conditioned in the container. |
typeTested_container_minimumVolume_x_code | String | The typeTested-container-minimumVolume[x]-code of the typeTested-container-minimumVolume[x]-code. The minimum volume to be conditioned in the container. |
typeTested_container_additive_id | String | The typeTested-container-additive-id of the typeTested-container-additive-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
typeTested_container_additive_extension | String | The typeTested-container-additive-extension of the typeTested-container-additive-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
typeTested_container_additive_modifierExtension | String | The typeTested-container-additive-modifierExtension of the typeTested-container-additive-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
typeTested_container_additive_additive_x_coding | String | The coding of the typeTested-container-additive-additive[x]. Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. |
typeTested_container_additive_additive_x_text | String | The text of the typeTested-container-additive-additive[x]. Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. |
typeTested_container_preparation | String | The typeTested-container-preparation of the typeTested-container-preparation. Special processing that should be applied to the container for this kind of specimen. |
typeTested_requirement | String | The typeTested-requirement of the typeTested-requirement. Requirements for delivery and special handling of this kind of conditioned specimen. |
typeTested_retentionTime | String | The typeTested-retentionTime of the typeTested-retentionTime. The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing. |
typeTested_rejectionCriterion_coding | String | The coding of the typeTested-rejectionCriterion. Criterion for rejection of the specimen in its container by the laboratory. |
typeTested_rejectionCriterion_text | String | The text of the typeTested-rejectionCriterion. Criterion for rejection of the specimen in its container by the laboratory. |
typeTested_handling_id | String | The typeTested-handling-id of the typeTested-handling-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
typeTested_handling_extension | String | The typeTested-handling-extension of the typeTested-handling-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
typeTested_handling_modifierExtension | String | The typeTested-handling-modifierExtension of the typeTested-handling-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
typeTested_handling_temperatureQualifier_coding | String | The coding of the typeTested-handling-temperatureQualifier. It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element. |
typeTested_handling_temperatureQualifier_text | String | The text of the typeTested-handling-temperatureQualifier. It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element. |
typeTested_handling_temperatureRange_low | String | The typeTested-handling-temperatureRange-low of the typeTested-handling-temperatureRange-low. The temperature interval for this set of handling instructions. |
typeTested_handling_temperatureRange_high | String | The typeTested-handling-temperatureRange-high of the typeTested-handling-temperatureRange-high. The temperature interval for this set of handling instructions. |
typeTested_handling_maxDuration | String | The typeTested-handling-maxDuration of the typeTested-handling-maxDuration. The maximum time interval of preservation of the specimen with these conditions. |
typeTested_handling_instruction | String | The typeTested-handling-instruction of the typeTested-handling-instruction. Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_container_start | String | The SP_container_start search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_container_end | String | The SP_container_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_type_end | String | The SP_type_end search parameter. |
SP_type_start | String | The SP_type_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SubscriptionStatus view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
status | String | The status of the subscription, which marks the server state for managing the subscription. |
type | String | The type of event being conveyed with this notification. |
eventsSinceSubscriptionStart | String | The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications. |
eventsInNotification | Int | The total number of actual events represented within this notification. For handshake and heartbeat notifications, this will be zero or not present. For event-notifications, this number may be one or more, depending on server batching. |
notificationEvent_id | String | The notificationEvent-id of the notificationEvent-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
notificationEvent_extension | String | The notificationEvent-extension of the notificationEvent-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
notificationEvent_modifierExtension | String | The notificationEvent-modifierExtension of the notificationEvent-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
notificationEvent_eventNumber | String | The notificationEvent-eventNumber of the notificationEvent-eventNumber. The sequential number of this event in this subscription context. Note that this value is a 64-bit integer value, encoded as a string. |
notificationEvent_timestamp | String | The notificationEvent-timestamp of the notificationEvent-timestamp. The actual time this event occured on the server. |
notificationEvent_focus_display | String | The display of the notificationEvent-focus. The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object. |
notificationEvent_focus_reference | String | The reference of the notificationEvent-focus. The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object. |
notificationEvent_focus_identifier_value | String | The value of the notificationEvent-focus-identifier. The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object. |
notificationEvent_focus_type | String | The notificationEvent-focus-type of the notificationEvent-focus-type. The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object. |
notificationEvent_additionalContext_display | String | The display of the notificationEvent-additionalContext. Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects. |
notificationEvent_additionalContext_reference | String | The reference of the notificationEvent-additionalContext. Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects. |
notificationEvent_additionalContext_identifier_value | String | The value of the notificationEvent-additionalContext-identifier. Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects. |
notificationEvent_additionalContext_type | String | The notificationEvent-additionalContext-type of the notificationEvent-additionalContext-type. Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects. |
subscription_display | String | The display of the subscription. The reference to the Subscription which generated this notification. |
subscription_reference | String | The reference of the subscription. The reference to the Subscription which generated this notification. |
subscription_identifier_value | String | The value of the subscription-identifier. The reference to the Subscription which generated this notification. |
subscription_type | String | The subscription-type of the subscription-type. The reference to the Subscription which generated this notification. |
topic | String | The reference to the SubscriptionTopic for the Subscription which generated this notification. |
error_coding | String | The coding of the error. A record of errors that occurred when the server processed a notification. |
error_text | String | The text of the error. A record of errors that occurred when the server processed a notification. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SubscriptionTopic view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it clinically safe for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it clinically safe for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URL that is used to identify this SubscriptionTopic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
version | String | The identifier that is used to identify this version of the SubscriptionTopic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. |
title | String | A short, descriptive, user-friendly title for the SubscriptionTopic, for example, admission . |
derivedFrom | String | The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic. |
status | String | The current state of the SubscriptionTopic. |
experimental | Bool | A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
date | Datetime | For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal. |
publisher | String | Helps establish the authority/credibility of the SubscriptionTopic. May also allow for contact. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
description | String | A free text natural language description of the Topic from the consumer's perspective. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions. |
jurisdiction_coding | String | The coding of the jurisdiction. A jurisdiction in which the Topic is intended to be used. |
jurisdiction_text | String | The text of the jurisdiction. A jurisdiction in which the Topic is intended to be used. |
purpose | String | Explains why this Topic is needed and why it has been designed as it has. |
copyright | String | A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic. |
approvalDate | Date | The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
lastReviewDate | Date | The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. |
effectivePeriod_start | Datetime | The start of the effectivePeriod. The period during which the SubscriptionTopic content was or is planned to be effective. |
effectivePeriod_end | Datetime | The end of the effectivePeriod. The period during which the SubscriptionTopic content was or is planned to be effective. |
resourceTrigger_id | String | The resourceTrigger-id of the resourceTrigger-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
resourceTrigger_extension | String | The resourceTrigger-extension of the resourceTrigger-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
resourceTrigger_modifierExtension | String | The resourceTrigger-modifierExtension of the resourceTrigger-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
resourceTrigger_description | String | The resourceTrigger-description of the resourceTrigger-description. The human readable description of this resource trigger for the SubscriptionTopic - for example, An Encounter enters the 'in-progress' state . |
resourceTrigger_resource | String | The resourceTrigger-resource of the resourceTrigger-resource. URL of the Resource that is the type used in this resource trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, Patient maps to http://hl7.org/fhir/StructureDefinition/Patient. |
resourceTrigger_supportedInteraction | String | The resourceTrigger-supportedInteraction of the resourceTrigger-supportedInteraction. The FHIR RESTful interaction which can be used to trigger a notification for the SubscriptionTopic. Multiple values are considered OR joined (e.g., CREATE or UPDATE). |
resourceTrigger_queryCriteria_id | String | The resourceTrigger-queryCriteria-id of the resourceTrigger-queryCriteria-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
resourceTrigger_queryCriteria_extension | String | The resourceTrigger-queryCriteria-extension of the resourceTrigger-queryCriteria-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
resourceTrigger_queryCriteria_modifierExtension | String | The resourceTrigger-queryCriteria-modifierExtension of the resourceTrigger-queryCriteria-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
resourceTrigger_queryCriteria_previous | String | The resourceTrigger-queryCriteria-previous of the resourceTrigger-queryCriteria-previous. The FHIR query based rules are applied to the previous resource state (e.g., state before an update). |
resourceTrigger_queryCriteria_resultForCreate | String | The resourceTrigger-queryCriteria-resultForCreate of the resourceTrigger-queryCriteria-resultForCreate. What behavior a server will exhibit if the previous state of a resource does NOT exist (e.g., prior to a create). |
resourceTrigger_queryCriteria_current | String | The resourceTrigger-queryCriteria-current of the resourceTrigger-queryCriteria-current. The FHIR query based rules are applied to the current resource state (e.g., state after an update). |
resourceTrigger_queryCriteria_resultForDelete | String | The resourceTrigger-queryCriteria-resultForDelete of the resourceTrigger-queryCriteria-resultForDelete. What behavior a server will exhibit if the current state of a resource does NOT exist (e.g., after a DELETE). |
resourceTrigger_queryCriteria_requireBoth | Bool | The resourceTrigger-queryCriteria-requireBoth of the resourceTrigger-queryCriteria-requireBoth. If set to true, both current and previous criteria must evaluate true to trigger a notification for this topic. Otherwise a notification for this topic will be triggered if either one evaluates to true. |
resourceTrigger_fhirPathCriteria | String | The resourceTrigger-fhirPathCriteria of the resourceTrigger-fhirPathCriteria. The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic. |
eventTrigger_id | String | The eventTrigger-id of the eventTrigger-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
eventTrigger_extension | String | The eventTrigger-extension of the eventTrigger-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
eventTrigger_modifierExtension | String | The eventTrigger-modifierExtension of the eventTrigger-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
eventTrigger_description | String | The eventTrigger-description of the eventTrigger-description. The human readable description of an event to trigger a notification for the SubscriptionTopic - for example, Patient Admission, as defined in HL7v2 via message ADT^A01 . Multiple values are considered OR joined (e.g., matching any single event listed). |
eventTrigger_event_coding | String | The coding of the eventTrigger-event. A well-defined event which can be used to trigger notifications from the SubscriptionTopic. |
eventTrigger_event_text | String | The text of the eventTrigger-event. A well-defined event which can be used to trigger notifications from the SubscriptionTopic. |
eventTrigger_resource | String | The eventTrigger-resource of the eventTrigger-resource. URL of the Resource that is the focus type used in this event trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, Patient maps to http://hl7.org/fhir/StructureDefinition/Patient. |
canFilterBy_id | String | The canFilterBy-id of the canFilterBy-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
canFilterBy_extension | String | The canFilterBy-extension of the canFilterBy-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
canFilterBy_modifierExtension | String | The canFilterBy-modifierExtension of the canFilterBy-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
canFilterBy_description | String | The canFilterBy-description of the canFilterBy-description. Description of how this filtering parameter is intended to be used. |
canFilterBy_resource | String | The canFilterBy-resource of the canFilterBy-resource. URL of the Resource that is the type used in this filter. This is the focus of the topic (or one of them if there are more than one). It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present. |
canFilterBy_filterParameter | String | The canFilterBy-filterParameter of the canFilterBy-filterParameter. Either the canonical URL to a search parameter (like http://hl7.org/fhir/SearchParameter/encounter-patient ) or topic-defined parameter (like hub.event ) which is a label for the filter. |
canFilterBy_modifier | String | The canFilterBy-modifier of the canFilterBy-modifier. Allowable operators to apply when determining matches (Search Modifiers). |
notificationShape_id | String | The notificationShape-id of the notificationShape-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
notificationShape_extension | String | The notificationShape-extension of the notificationShape-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
notificationShape_modifierExtension | String | The notificationShape-modifierExtension of the notificationShape-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
notificationShape_resource | String | The notificationShape-resource of the notificationShape-resource. URL of the Resource that is the type used in this shape. This is the focus of the topic (or one of them if there are more than one) and the root resource for this shape definition. It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present. |
notificationShape_include | String | The notificationShape-include of the notificationShape-include. Search-style _include directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them. |
notificationShape_revInclude | String | The notificationShape-revInclude of the notificationShape-revInclude. Search-style _revinclude directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them. |
SP_source | String | The SP_source search parameter. |
SP_resource | String | The SP_resource search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_trigger_description | String | The SP_trigger_description search parameter. |
SP_derived_or_self | String | The SP_derived_or_self search parameter. |
Substance view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Unique identifier for the substance. |
identifier_use | String | The identifier-use of the identifier-use. Unique identifier for the substance. |
identifier_type_coding | String | The coding of the identifier-type. Unique identifier for the substance. |
identifier_type_text | String | The text of the identifier-type. Unique identifier for the substance. |
identifier_system | String | The identifier-system of the identifier-system. Unique identifier for the substance. |
identifier_period_start | String | The start of the identifier-period. Unique identifier for the substance. |
identifier_period_end | String | The end of the identifier-period. Unique identifier for the substance. |
status | String | A code to indicate if the substance is actively used. |
category_coding | String | The coding of the category. A code that classifies the general type of substance. This is used for searching, sorting and display purposes. |
category_text | String | The text of the category. A code that classifies the general type of substance. This is used for searching, sorting and display purposes. |
code_coding | String | The coding of the code. A code (or set of codes) that identify this substance. |
code_text | String | The text of the code. A code (or set of codes) that identify this substance. |
description | String | A description of the substance - its appearance, handling requirements, and other usage notes. |
instance_id | String | The instance-id of the instance-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
instance_extension | String | The instance-extension of the instance-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
instance_modifierExtension | String | The instance-modifierExtension of the instance-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
instance_identifier_value | String | The value of the instance-identifier. Identifier associated with the package/container (usually a label affixed directly). |
instance_identifier_use | String | The instance-identifier-use of the instance-identifier-use. Identifier associated with the package/container (usually a label affixed directly). |
instance_identifier_type_coding | String | The coding of the instance-identifier-type. Identifier associated with the package/container (usually a label affixed directly). |
instance_identifier_type_text | String | The text of the instance-identifier-type. Identifier associated with the package/container (usually a label affixed directly). |
instance_identifier_system | String | The instance-identifier-system of the instance-identifier-system. Identifier associated with the package/container (usually a label affixed directly). |
instance_identifier_period_start | Datetime | The start of the instance-identifier-period. Identifier associated with the package/container (usually a label affixed directly). |
instance_identifier_period_end | Datetime | The end of the instance-identifier-period. Identifier associated with the package/container (usually a label affixed directly). |
instance_expiry | Datetime | The instance-expiry of the instance-expiry. When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry. |
instance_quantity_value | Decimal | The value of the instance-quantity. The amount of the substance. |
instance_quantity_unit | String | The unit of the instance-quantity. The amount of the substance. |
instance_quantity_system | String | The system of the instance-quantity. The amount of the substance. |
instance_quantity_comparator | String | The instance-quantity-comparator of the instance-quantity-comparator. The amount of the substance. |
instance_quantity_code | String | The instance-quantity-code of the instance-quantity-code. The amount of the substance. |
ingredient_id | String | The ingredient-id of the ingredient-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ingredient_extension | String | The ingredient-extension of the ingredient-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
ingredient_modifierExtension | String | The ingredient-modifierExtension of the ingredient-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
ingredient_quantity | String | The ingredient-quantity of the ingredient-quantity. The amount of the ingredient in the substance - a concentration ratio. |
ingredient_substance_x_coding | String | The coding of the ingredient-substance[x]. Another substance that is a component of this substance. |
ingredient_substance_x_text | String | The text of the ingredient-substance[x]. Another substance that is a component of this substance. |
SP_source | String | The SP_source search parameter. |
SP_container_identifier_end | String | The SP_container_identifier_end search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_substance_reference | String | The SP_substance_reference search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_quantity | String | The SP_quantity search parameter. |
SP_container_identifier_start | String | The SP_container_identifier_start search parameter. |
SP_expiry | String | The SP_expiry search parameter. |
SP_list | String | The SP_list search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SubstanceDefinition view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifier by which this substance is known. |
identifier_use | String | The identifier-use of the identifier-use. Identifier by which this substance is known. |
identifier_type_coding | String | The coding of the identifier-type. Identifier by which this substance is known. |
identifier_type_text | String | The text of the identifier-type. Identifier by which this substance is known. |
identifier_system | String | The identifier-system of the identifier-system. Identifier by which this substance is known. |
identifier_period_start | String | The start of the identifier-period. Identifier by which this substance is known. |
identifier_period_end | String | The end of the identifier-period. Identifier by which this substance is known. |
version | String | A business level identifier of the substance. |
status_coding | String | The coding of the status. Status of substance within the catalogue e.g. approved. |
status_text | String | The text of the status. Status of substance within the catalogue e.g. approved. |
classification_coding | String | The coding of the classification. A high level categorization, e.g. polymer or nucleic acid, or food, chemical, biological, or a lower level such as the general types of polymer (linear or branch chain) or type of impurity (process related or contaminant). |
classification_text | String | The text of the classification. A high level categorization, e.g. polymer or nucleic acid, or food, chemical, biological, or a lower level such as the general types of polymer (linear or branch chain) or type of impurity (process related or contaminant). |
domain_coding | String | The coding of the domain. If the substance applies to only human or veterinary use. |
domain_text | String | The text of the domain. If the substance applies to only human or veterinary use. |
grade_coding | String | The coding of the grade. The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard). |
grade_text | String | The text of the grade. The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard). |
description | String | Textual description of the substance. |
informationSource_display | String | The display of the informationSource. Supporting literature. |
informationSource_reference | String | The reference of the informationSource. Supporting literature. |
informationSource_identifier_value | String | The value of the informationSource-identifier. Supporting literature. |
informationSource_type | String | The informationSource-type of the informationSource-type. Supporting literature. |
note | String | Textual comment about the substance's catalogue or registry record. |
manufacturer_display | String | The display of the manufacturer. A company that makes this substance. |
manufacturer_reference | String | The reference of the manufacturer. A company that makes this substance. |
manufacturer_identifier_value | String | The value of the manufacturer-identifier. A company that makes this substance. |
manufacturer_type | String | The manufacturer-type of the manufacturer-type. A company that makes this substance. |
supplier_display | String | The display of the supplier. A company that supplies this substance. |
supplier_reference | String | The reference of the supplier. A company that supplies this substance. |
supplier_identifier_value | String | The value of the supplier-identifier. A company that supplies this substance. |
supplier_type | String | The supplier-type of the supplier-type. A company that supplies this substance. |
moiety_id | String | The moiety-id of the moiety-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
moiety_extension | String | The moiety-extension of the moiety-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
moiety_modifierExtension | String | The moiety-modifierExtension of the moiety-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
moiety_role_coding | String | The coding of the moiety-role. Role that the moiety is playing. |
moiety_role_text | String | The text of the moiety-role. Role that the moiety is playing. |
moiety_identifier_value | String | The value of the moiety-identifier. Identifier by which this moiety substance is known. |
moiety_identifier_use | String | The moiety-identifier-use of the moiety-identifier-use. Identifier by which this moiety substance is known. |
moiety_identifier_type_coding | String | The coding of the moiety-identifier-type. Identifier by which this moiety substance is known. |
moiety_identifier_type_text | String | The text of the moiety-identifier-type. Identifier by which this moiety substance is known. |
moiety_identifier_system | String | The moiety-identifier-system of the moiety-identifier-system. Identifier by which this moiety substance is known. |
moiety_identifier_period_start | Datetime | The start of the moiety-identifier-period. Identifier by which this moiety substance is known. |
moiety_identifier_period_end | Datetime | The end of the moiety-identifier-period. Identifier by which this moiety substance is known. |
moiety_name | String | The moiety-name of the moiety-name. Textual name for this moiety substance. |
moiety_stereochemistry_coding | String | The coding of the moiety-stereochemistry. Stereochemistry type. |
moiety_stereochemistry_text | String | The text of the moiety-stereochemistry. Stereochemistry type. |
moiety_opticalActivity_coding | String | The coding of the moiety-opticalActivity. Optical activity type. |
moiety_opticalActivity_text | String | The text of the moiety-opticalActivity. Optical activity type. |
moiety_molecularFormula | String | The moiety-molecularFormula of the moiety-molecularFormula. Molecular formula for this moiety of this substance, typically using the Hill system. |
moiety_amount_x_value | Decimal | The value of the moiety-amount[x]. Quantitative value for this moiety. |
moiety_amount_x_unit | String | The unit of the moiety-amount[x]. Quantitative value for this moiety. |
moiety_amount_x_system | String | The system of the moiety-amount[x]. Quantitative value for this moiety. |
moiety_amount_x_comparator | String | The moiety-amount[x]-comparator of the moiety-amount[x]-comparator. Quantitative value for this moiety. |
moiety_amount_x_code | String | The moiety-amount[x]-code of the moiety-amount[x]-code. Quantitative value for this moiety. |
moiety_amountType_coding | String | The coding of the moiety-amountType. The measurement type of the quantitative value. |
moiety_amountType_text | String | The text of the moiety-amountType. The measurement type of the quantitative value. |
property_id | String | The property-id of the property-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
property_extension | String | The property-extension of the property-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
property_modifierExtension | String | The property-modifierExtension of the property-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
property_type_coding | String | The coding of the property-type. A code expressing the type of characteristic. |
property_type_text | String | The text of the property-type. A code expressing the type of characteristic. |
property_value_x_coding | String | The coding of the property-value[x]. A value for the characteristic. |
property_value_x_text | String | The text of the property-value[x]. A value for the characteristic. |
molecularWeight_id | String | The molecularWeight-id of the molecularWeight-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
molecularWeight_extension | String | The molecularWeight-extension of the molecularWeight-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
molecularWeight_modifierExtension | String | The molecularWeight-modifierExtension of the molecularWeight-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
molecularWeight_method_coding | String | The coding of the molecularWeight-method. The method by which the molecular weight was determined. |
molecularWeight_method_text | String | The text of the molecularWeight-method. The method by which the molecular weight was determined. |
molecularWeight_type_coding | String | The coding of the molecularWeight-type. Type of molecular weight such as exact, average (also known as. number average), weight average. |
molecularWeight_type_text | String | The text of the molecularWeight-type. Type of molecular weight such as exact, average (also known as. number average), weight average. |
molecularWeight_amount_value | Decimal | The value of the molecularWeight-amount. Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field. |
molecularWeight_amount_unit | String | The unit of the molecularWeight-amount. Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field. |
molecularWeight_amount_system | String | The system of the molecularWeight-amount. Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field. |
molecularWeight_amount_comparator | String | The molecularWeight-amount-comparator of the molecularWeight-amount-comparator. Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field. |
molecularWeight_amount_code | String | The molecularWeight-amount-code of the molecularWeight-amount-code. Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field. |
structure_id | String | The structure-id of the structure-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
structure_extension | String | The structure-extension of the structure-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
structure_modifierExtension | String | The structure-modifierExtension of the structure-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
structure_stereochemistry_coding | String | The coding of the structure-stereochemistry. Stereochemistry type. |
structure_stereochemistry_text | String | The text of the structure-stereochemistry. Stereochemistry type. |
structure_opticalActivity_coding | String | The coding of the structure-opticalActivity. Optical activity type. |
structure_opticalActivity_text | String | The text of the structure-opticalActivity. Optical activity type. |
structure_molecularFormula | String | The structure-molecularFormula of the structure-molecularFormula. Molecular formula of this substance, typically using the Hill system. |
structure_molecularFormulaByMoiety | String | The structure-molecularFormulaByMoiety of the structure-molecularFormulaByMoiety. Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_list | String | The SP_list search parameter. |
SP_domain_end | String | The SP_domain_end search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_classification_end | String | The SP_classification_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_classification_start | String | The SP_classification_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_domain_start | String | The SP_domain_start search parameter. |
SP_name | String | The SP_name search parameter. |
SupplyDelivery view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifier for the supply delivery event that is used to identify it across multiple disparate systems. |
identifier_use | String | The identifier-use of the identifier-use. Identifier for the supply delivery event that is used to identify it across multiple disparate systems. |
identifier_type_coding | String | The coding of the identifier-type. Identifier for the supply delivery event that is used to identify it across multiple disparate systems. |
identifier_type_text | String | The text of the identifier-type. Identifier for the supply delivery event that is used to identify it across multiple disparate systems. |
identifier_system | String | The identifier-system of the identifier-system. Identifier for the supply delivery event that is used to identify it across multiple disparate systems. |
identifier_period_start | String | The start of the identifier-period. Identifier for the supply delivery event that is used to identify it across multiple disparate systems. |
identifier_period_end | String | The end of the identifier-period. Identifier for the supply delivery event that is used to identify it across multiple disparate systems. |
basedOn_display | String | The display of the basedOn. A plan, proposal or order that is fulfilled in whole or in part by this event. |
basedOn_reference | String | The reference of the basedOn. A plan, proposal or order that is fulfilled in whole or in part by this event. |
basedOn_identifier_value | String | The value of the basedOn-identifier. A plan, proposal or order that is fulfilled in whole or in part by this event. |
basedOn_type | String | The basedOn-type of the basedOn-type. A plan, proposal or order that is fulfilled in whole or in part by this event. |
partOf_display | String | The display of the partOf. A larger event of which this particular event is a component or step. |
partOf_reference | String | The reference of the partOf. A larger event of which this particular event is a component or step. |
partOf_identifier_value | String | The value of the partOf-identifier. A larger event of which this particular event is a component or step. |
partOf_type | String | The partOf-type of the partOf-type. A larger event of which this particular event is a component or step. |
status | String | A code specifying the state of the dispense event. |
patient_display | String | The display of the patient. A link to a resource representing the person whom the delivered item is for. |
patient_reference | String | The reference of the patient. A link to a resource representing the person whom the delivered item is for. |
patient_identifier_value | String | The value of the patient-identifier. A link to a resource representing the person whom the delivered item is for. |
patient_type | String | The patient-type of the patient-type. A link to a resource representing the person whom the delivered item is for. |
type_coding | String | The coding of the type. Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. |
type_text | String | The text of the type. Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. |
suppliedItem_id | String | The suppliedItem-id of the suppliedItem-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
suppliedItem_extension | String | The suppliedItem-extension of the suppliedItem-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
suppliedItem_modifierExtension | String | The suppliedItem-modifierExtension of the suppliedItem-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
suppliedItem_quantity_value | Decimal | The value of the suppliedItem-quantity. The amount of supply that has been dispensed. Includes unit of measure. |
suppliedItem_quantity_unit | String | The unit of the suppliedItem-quantity. The amount of supply that has been dispensed. Includes unit of measure. |
suppliedItem_quantity_system | String | The system of the suppliedItem-quantity. The amount of supply that has been dispensed. Includes unit of measure. |
suppliedItem_quantity_comparator | String | The suppliedItem-quantity-comparator of the suppliedItem-quantity-comparator. The amount of supply that has been dispensed. Includes unit of measure. |
suppliedItem_quantity_code | String | The suppliedItem-quantity-code of the suppliedItem-quantity-code. The amount of supply that has been dispensed. Includes unit of measure. |
suppliedItem_item_x_coding | String | The coding of the suppliedItem-item[x]. Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. |
suppliedItem_item_x_text | String | The text of the suppliedItem-item[x]. Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. |
occurrence_x_ | Datetime | The date or time(s) the activity occurred. |
supplier_display | String | The display of the supplier. The individual responsible for dispensing the medication, supplier or device. |
supplier_reference | String | The reference of the supplier. The individual responsible for dispensing the medication, supplier or device. |
supplier_identifier_value | String | The value of the supplier-identifier. The individual responsible for dispensing the medication, supplier or device. |
supplier_type | String | The supplier-type of the supplier-type. The individual responsible for dispensing the medication, supplier or device. |
destination_display | String | The display of the destination. Identification of the facility/location where the Supply was shipped to, as part of the dispense event. |
destination_reference | String | The reference of the destination. Identification of the facility/location where the Supply was shipped to, as part of the dispense event. |
destination_identifier_value | String | The value of the destination-identifier. Identification of the facility/location where the Supply was shipped to, as part of the dispense event. |
destination_type | String | The destination-type of the destination-type. Identification of the facility/location where the Supply was shipped to, as part of the dispense event. |
receiver_display | String | The display of the receiver. Identifies the person who picked up the Supply. |
receiver_reference | String | The reference of the receiver. Identifies the person who picked up the Supply. |
receiver_identifier_value | String | The value of the receiver-identifier. Identifies the person who picked up the Supply. |
receiver_type | String | The receiver-type of the receiver-type. Identifies the person who picked up the Supply. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_receiver | String | The SP_receiver search parameter. |
SP_supplier | String | The SP_supplier search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SupplyRequest view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
identifier_use | String | The identifier-use of the identifier-use. Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
identifier_type_coding | String | The coding of the identifier-type. Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
identifier_type_text | String | The text of the identifier-type. Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
identifier_system | String | The identifier-system of the identifier-system. Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
identifier_period_start | String | The start of the identifier-period. Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
identifier_period_end | String | The end of the identifier-period. Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
status | String | Status of the supply request. |
category_coding | String | The coding of the category. Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process. |
category_text | String | The text of the category. Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process. |
priority | String | Indicates how quickly this SupplyRequest should be addressed with respect to other requests. |
item_x_coding | String | The coding of the item[x]. The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. |
item_x_text | String | The text of the item[x]. The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. |
quantity_value | Decimal | The value of the quantity. The amount that is being ordered of the indicated item. |
quantity_unit | String | The unit of the quantity. The amount that is being ordered of the indicated item. |
quantity_system | String | The system of the quantity. The amount that is being ordered of the indicated item. |
quantity_comparator | String | The quantity-comparator of the quantity-comparator. The amount that is being ordered of the indicated item. |
quantity_code | String | The quantity-code of the quantity-code. The amount that is being ordered of the indicated item. |
parameter_id | String | The parameter-id of the parameter-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
parameter_extension | String | The parameter-extension of the parameter-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
parameter_modifierExtension | String | The parameter-modifierExtension of the parameter-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
parameter_code_coding | String | The coding of the parameter-code. A code or string that identifies the device detail being asserted. |
parameter_code_text | String | The text of the parameter-code. A code or string that identifies the device detail being asserted. |
parameter_value_x_coding | String | The coding of the parameter-value[x]. The value of the device detail. |
parameter_value_x_text | String | The text of the parameter-value[x]. The value of the device detail. |
occurrence_x_ | Datetime | When the request should be fulfilled. |
authoredOn | Datetime | When the request was made. |
requester_display | String | The display of the requester. The device, practitioner, etc. who initiated the request. |
requester_reference | String | The reference of the requester. The device, practitioner, etc. who initiated the request. |
requester_identifier_value | String | The value of the requester-identifier. The device, practitioner, etc. who initiated the request. |
requester_type | String | The requester-type of the requester-type. The device, practitioner, etc. who initiated the request. |
supplier_display | String | The display of the supplier. Who is intended to fulfill the request. |
supplier_reference | String | The reference of the supplier. Who is intended to fulfill the request. |
supplier_identifier_value | String | The value of the supplier-identifier. Who is intended to fulfill the request. |
supplier_type | String | The supplier-type of the supplier-type. Who is intended to fulfill the request. |
reasonCode_coding | String | The coding of the reasonCode. The reason why the supply item was requested. |
reasonCode_text | String | The text of the reasonCode. The reason why the supply item was requested. |
reasonReference_display | String | The display of the reasonReference. The reason why the supply item was requested. |
reasonReference_reference | String | The reference of the reasonReference. The reason why the supply item was requested. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. The reason why the supply item was requested. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. The reason why the supply item was requested. |
deliverFrom_display | String | The display of the deliverFrom. Where the supply is expected to come from. |
deliverFrom_reference | String | The reference of the deliverFrom. Where the supply is expected to come from. |
deliverFrom_identifier_value | String | The value of the deliverFrom-identifier. Where the supply is expected to come from. |
deliverFrom_type | String | The deliverFrom-type of the deliverFrom-type. Where the supply is expected to come from. |
deliverTo_display | String | The display of the deliverTo. Where the supply is destined to go. |
deliverTo_reference | String | The reference of the deliverTo. Where the supply is destined to go. |
deliverTo_identifier_value | String | The value of the deliverTo-identifier. Where the supply is destined to go. |
deliverTo_type | String | The deliverTo-type of the deliverTo-type. Where the supply is destined to go. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_supplier | String | The SP_supplier search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_category_end | String | The SP_category_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_category_start | String | The SP_category_start search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_date | String | The SP_date search parameter. |
SP_requester | String | The SP_requester search parameter. |
Task view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. The business identifier for this task. |
identifier_use | String | The identifier-use of the identifier-use. The business identifier for this task. |
identifier_type_coding | String | The coding of the identifier-type. The business identifier for this task. |
identifier_type_text | String | The text of the identifier-type. The business identifier for this task. |
identifier_system | String | The identifier-system of the identifier-system. The business identifier for this task. |
identifier_period_start | String | The start of the identifier-period. The business identifier for this task. |
identifier_period_end | String | The end of the identifier-period. The business identifier for this task. |
instantiatesCanonical | String | The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. |
instantiatesUri | String | The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. |
basedOn_display | String | The display of the basedOn. BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a 'request' resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the 'request' resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient. |
basedOn_reference | String | The reference of the basedOn. BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a 'request' resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the 'request' resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient. |
basedOn_identifier_value | String | The value of the basedOn-identifier. BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a 'request' resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the 'request' resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient. |
basedOn_type | String | The basedOn-type of the basedOn-type. BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a 'request' resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the 'request' resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient. |
groupIdentifier_value | String | The value of the groupIdentifier. An identifier that links together multiple tasks and other requests that were created in the same context. |
groupIdentifier_use | String | The groupIdentifier-use of the groupIdentifier-use. An identifier that links together multiple tasks and other requests that were created in the same context. |
groupIdentifier_type_coding | String | The coding of the groupIdentifier-type. An identifier that links together multiple tasks and other requests that were created in the same context. |
groupIdentifier_type_text | String | The text of the groupIdentifier-type. An identifier that links together multiple tasks and other requests that were created in the same context. |
groupIdentifier_system | String | The groupIdentifier-system of the groupIdentifier-system. An identifier that links together multiple tasks and other requests that were created in the same context. |
groupIdentifier_period_start | Datetime | The start of the groupIdentifier-period. An identifier that links together multiple tasks and other requests that were created in the same context. |
groupIdentifier_period_end | Datetime | The end of the groupIdentifier-period. An identifier that links together multiple tasks and other requests that were created in the same context. |
partOf_display | String | The display of the partOf. Task that this particular task is part of. |
partOf_reference | String | The reference of the partOf. Task that this particular task is part of. |
partOf_identifier_value | String | The value of the partOf-identifier. Task that this particular task is part of. |
partOf_type | String | The partOf-type of the partOf-type. Task that this particular task is part of. |
status | String | The current status of the task. |
statusReason_coding | String | The coding of the statusReason. An explanation as to why this task is held, failed, was refused, etc. |
statusReason_text | String | The text of the statusReason. An explanation as to why this task is held, failed, was refused, etc. |
businessStatus_coding | String | The coding of the businessStatus. Contains business-specific nuances of the business state. |
businessStatus_text | String | The text of the businessStatus. Contains business-specific nuances of the business state. |
intent | String | Indicates the 'level' of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc. |
priority | String | Indicates how quickly the Task should be addressed with respect to other requests. |
code_coding | String | The coding of the code. A name or code (or both) briefly describing what the task involves. |
code_text | String | The text of the code. A name or code (or both) briefly describing what the task involves. |
description | String | A free-text description of what is to be performed. |
focus_display | String | The display of the focus. The request being actioned or the resource being manipulated by this task. |
focus_reference | String | The reference of the focus. The request being actioned or the resource being manipulated by this task. |
focus_identifier_value | String | The value of the focus-identifier. The request being actioned or the resource being manipulated by this task. |
focus_type | String | The focus-type of the focus-type. The request being actioned or the resource being manipulated by this task. |
for_display | String | The display of the for. The entity who benefits from the performance of the service specified in the task (e.g., the patient). |
for_reference | String | The reference of the for. The entity who benefits from the performance of the service specified in the task (e.g., the patient). |
for_identifier_value | String | The value of the for-identifier. The entity who benefits from the performance of the service specified in the task (e.g., the patient). |
for_type | String | The for-type of the for-type. The entity who benefits from the performance of the service specified in the task (e.g., the patient). |
encounter_display | String | The display of the encounter. The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. |
encounter_reference | String | The reference of the encounter. The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. |
encounter_identifier_value | String | The value of the encounter-identifier. The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. |
encounter_type | String | The encounter-type of the encounter-type. The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. |
executionPeriod_start | Datetime | The start of the executionPeriod. Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end). |
executionPeriod_end | Datetime | The end of the executionPeriod. Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end). |
authoredOn | Datetime | The date and time this task was created. |
lastModified | Datetime | The date and time of last modification to this task. |
requester_display | String | The display of the requester. The creator of the task. |
requester_reference | String | The reference of the requester. The creator of the task. |
requester_identifier_value | String | The value of the requester-identifier. The creator of the task. |
requester_type | String | The requester-type of the requester-type. The creator of the task. |
performerType_coding | String | The coding of the performerType. The kind of participant that should perform the task. |
performerType_text | String | The text of the performerType. The kind of participant that should perform the task. |
owner_display | String | The display of the owner. Individual organization or Device currently responsible for task execution. |
owner_reference | String | The reference of the owner. Individual organization or Device currently responsible for task execution. |
owner_identifier_value | String | The value of the owner-identifier. Individual organization or Device currently responsible for task execution. |
owner_type | String | The owner-type of the owner-type. Individual organization or Device currently responsible for task execution. |
location_display | String | The display of the location. Principal physical location where the this task is performed. |
location_reference | String | The reference of the location. Principal physical location where the this task is performed. |
location_identifier_value | String | The value of the location-identifier. Principal physical location where the this task is performed. |
location_type | String | The location-type of the location-type. Principal physical location where the this task is performed. |
reasonCode_coding | String | The coding of the reasonCode. A description or code indicating why this task needs to be performed. |
reasonCode_text | String | The text of the reasonCode. A description or code indicating why this task needs to be performed. |
reasonReference_display | String | The display of the reasonReference. A resource reference indicating why this task needs to be performed. |
reasonReference_reference | String | The reference of the reasonReference. A resource reference indicating why this task needs to be performed. |
reasonReference_identifier_value | String | The value of the reasonReference-identifier. A resource reference indicating why this task needs to be performed. |
reasonReference_type | String | The reasonReference-type of the reasonReference-type. A resource reference indicating why this task needs to be performed. |
insurance_display | String | The display of the insurance. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. |
insurance_reference | String | The reference of the insurance. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. |
insurance_identifier_value | String | The value of the insurance-identifier. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. |
insurance_type | String | The insurance-type of the insurance-type. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. |
note | String | Free-text information captured about the task as it progresses. |
relevantHistory_display | String | The display of the relevantHistory. Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task. |
relevantHistory_reference | String | The reference of the relevantHistory. Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task. |
relevantHistory_identifier_value | String | The value of the relevantHistory-identifier. Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task. |
relevantHistory_type | String | The relevantHistory-type of the relevantHistory-type. Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task. |
restriction_id | String | The restriction-id of the restriction-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
restriction_extension | String | The restriction-extension of the restriction-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
restriction_modifierExtension | String | The restriction-modifierExtension of the restriction-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
restriction_repetitions | Int | The restriction-repetitions of the restriction-repetitions. Indicates the number of times the requested action should occur. |
restriction_period_start | Datetime | The start of the restriction-period. Over what time-period is fulfillment sought. |
restriction_period_end | Datetime | The end of the restriction-period. Over what time-period is fulfillment sought. |
restriction_recipient_display | String | The display of the restriction-recipient. For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?. |
restriction_recipient_reference | String | The reference of the restriction-recipient. For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?. |
restriction_recipient_identifier_value | String | The value of the restriction-recipient-identifier. For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?. |
restriction_recipient_type | String | The restriction-recipient-type of the restriction-recipient-type. For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?. |
input_id | String | The input-id of the input-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
input_extension | String | The input-extension of the input-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
input_modifierExtension | String | The input-modifierExtension of the input-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
input_type_coding | String | The coding of the input-type. A code or description indicating how the input is intended to be used as part of the task execution. |
input_type_text | String | The text of the input-type. A code or description indicating how the input is intended to be used as part of the task execution. |
input_value_x_ | String | The input-value[x] of the input-value[x]. The value of the input parameter as a basic type. |
output_id | String | The output-id of the output-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
output_extension | String | The output-extension of the output-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
output_modifierExtension | String | The output-modifierExtension of the output-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
output_type_coding | String | The coding of the output-type. The name of the Output parameter. |
output_type_text | String | The text of the output-type. The name of the Output parameter. |
output_value_x_ | String | The output-value[x] of the output-value[x]. The value of the Output parameter as a basic type. |
SP_owner | String | The SP_owner search parameter. |
SP_source | String | The SP_source search parameter. |
SP_business_status_start | String | The SP_business_status_start search parameter. |
SP_performer_end | String | The SP_performer_end search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_business_status_end | String | The SP_business_status_end search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_subject | String | The SP_subject search parameter. |
SP_modified | String | The SP_modified search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_based_on | String | The SP_based_on search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_list | String | The SP_list search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_focus | String | The SP_focus search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_code_start | String | The SP_code_start search parameter. |
SP_group_identifier_end | String | The SP_group_identifier_end search parameter. |
SP_code_end | String | The SP_code_end search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_authored_on | String | The SP_authored_on search parameter. |
SP_part_of | String | The SP_part_of search parameter. |
SP_group_identifier_start | String | The SP_group_identifier_start search parameter. |
SP_performer_start | String | The SP_performer_start search parameter. |
SP_period | String | The SP_period search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_requester | String | The SP_requester search parameter. |
TestReport view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. Identifier for the TestScript assigned for external purposes outside the context of FHIR. |
identifier_use | String | The identifier-use of the identifier-use. Identifier for the TestScript assigned for external purposes outside the context of FHIR. |
identifier_type_coding | String | The coding of the identifier-type. Identifier for the TestScript assigned for external purposes outside the context of FHIR. |
identifier_type_text | String | The text of the identifier-type. Identifier for the TestScript assigned for external purposes outside the context of FHIR. |
identifier_system | String | The identifier-system of the identifier-system. Identifier for the TestScript assigned for external purposes outside the context of FHIR. |
identifier_period_start | Datetime | The start of the identifier-period. Identifier for the TestScript assigned for external purposes outside the context of FHIR. |
identifier_period_end | Datetime | The end of the identifier-period. Identifier for the TestScript assigned for external purposes outside the context of FHIR. |
name | String | A free text natural language name identifying the executed TestScript. |
status | String | The current state of this test report. |
testScript_display | String | The display of the testScript. Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`. |
testScript_reference | String | The reference of the testScript. Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`. |
testScript_identifier_value | String | The value of the testScript-identifier. Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`. |
testScript_type | String | The testScript-type of the testScript-type. Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`. |
result | String | The overall result from the execution of the TestScript. |
score | Decimal | The final score (percentage of tests passed) resulting from the execution of the TestScript. |
tester | String | Name of the tester producing this report (Organization or individual). |
issued | Datetime | When the TestScript was executed and this TestReport was generated. |
participant_id | String | The participant-id of the participant-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
participant_extension | String | The participant-extension of the participant-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
participant_modifierExtension | String | The participant-modifierExtension of the participant-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
participant_type | String | The participant-type of the participant-type. The type of participant. |
participant_uri | String | The participant-uri of the participant-uri. The uri of the participant. An absolute URL is preferred. |
participant_display | String | The participant-display of the participant-display. The display name of the participant. |
setup_id | String | The setup-id of the setup-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
setup_extension | String | The setup-extension of the setup-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
setup_modifierExtension | String | The setup-modifierExtension of the setup-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
setup_action_id | String | The setup-action-id of the setup-action-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
setup_action_extension | String | The setup-action-extension of the setup-action-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
setup_action_modifierExtension | String | The setup-action-modifierExtension of the setup-action-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
setup_action_operation_id | String | The setup-action-operation-id of the setup-action-operation-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
setup_action_operation_extension | String | The setup-action-operation-extension of the setup-action-operation-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
setup_action_operation_modifierExtension | String | The setup-action-operation-modifierExtension of the setup-action-operation-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
setup_action_operation_result | String | The setup-action-operation-result of the setup-action-operation-result. The result of this operation. |
setup_action_operation_message | String | The setup-action-operation-message of the setup-action-operation-message. An explanatory message associated with the result. |
setup_action_operation_detail | String | The setup-action-operation-detail of the setup-action-operation-detail. A link to further details on the result. |
setup_action_assert_id | String | The setup-action-assert-id of the setup-action-assert-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
setup_action_assert_extension | String | The setup-action-assert-extension of the setup-action-assert-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
setup_action_assert_modifierExtension | String | The setup-action-assert-modifierExtension of the setup-action-assert-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
setup_action_assert_result | String | The setup-action-assert-result of the setup-action-assert-result. The result of this assertion. |
setup_action_assert_message | String | The setup-action-assert-message of the setup-action-assert-message. An explanatory message associated with the result. |
setup_action_assert_detail | String | The setup-action-assert-detail of the setup-action-assert-detail. A link to further details on the result. |
test_id | String | The test-id of the test-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
test_extension | String | The test-extension of the test-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
test_modifierExtension | String | The test-modifierExtension of the test-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
test_name | String | The test-name of the test-name. The name of this test used for tracking/logging purposes by test engines. |
test_description | String | The test-description of the test-description. A short description of the test used by test engines for tracking and reporting purposes. |
test_action_id | String | The test-action-id of the test-action-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
test_action_extension | String | The test-action-extension of the test-action-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
test_action_modifierExtension | String | The test-action-modifierExtension of the test-action-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_testscript | String | The SP_testscript search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_participant | String | The SP_participant search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
TestScript view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
url | String | An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers. |
identifier_value | String | The value of the identifier. A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_use | String | The identifier-use of the identifier-use. A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_coding | String | The coding of the identifier-type. A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_type_text | String | The text of the identifier-type. A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_system | String | The identifier-system of the identifier-system. A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_start | Datetime | The start of the identifier-period. A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance. |
identifier_period_end | Datetime | The end of the identifier-period. A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance. |
version | String | The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
name | String | A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
title | String | A short, descriptive, user-friendly title for the test script. |
status | String | The status of this test script. Enables tracking the life-cycle of the content. |
experimental | Bool | A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
date | Datetime | The date (and optionally time) when the test script was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes. |
publisher | String | The name of the organization or individual that published the test script. |
contact | String | Contact details to assist a user in finding and communicating with the publisher. |
description | String | A free text natural language description of the test script from a consumer's perspective. |
useContext | String | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances. |
jurisdiction_coding | String | The coding of the jurisdiction. A legal or geographic region in which the test script is intended to be used. |
jurisdiction_text | String | The text of the jurisdiction. A legal or geographic region in which the test script is intended to be used. |
purpose | String | Explanation of why this test script is needed and why it has been designed as it has. |
copyright | String | A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script. |
origin_id | String | The origin-id of the origin-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
origin_extension | String | The origin-extension of the origin-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
origin_modifierExtension | String | The origin-modifierExtension of the origin-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
origin_index | Int | The origin-index of the origin-index. Abstract name given to an origin server in this test script. The name is provided as a number starting at 1. |
origin_profile_version | String | The version of the origin-profile. The type of origin profile the test system supports. |
origin_profile_code | String | The code of the origin-profile. The type of origin profile the test system supports. |
origin_profile_display | String | The display of the origin-profile. The type of origin profile the test system supports. |
origin_profile_userSelected | Bool | The userSelected of the origin-profile. The type of origin profile the test system supports. |
origin_profile_system | String | The origin-profile-system of the origin-profile-system. The type of origin profile the test system supports. |
destination_id | String | The destination-id of the destination-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
destination_extension | String | The destination-extension of the destination-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
destination_modifierExtension | String | The destination-modifierExtension of the destination-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
destination_index | Int | The destination-index of the destination-index. Abstract name given to a destination server in this test script. The name is provided as a number starting at 1. |
destination_profile_version | String | The version of the destination-profile. The type of destination profile the test system supports. |
destination_profile_code | String | The code of the destination-profile. The type of destination profile the test system supports. |
destination_profile_display | String | The display of the destination-profile. The type of destination profile the test system supports. |
destination_profile_userSelected | Bool | The userSelected of the destination-profile. The type of destination profile the test system supports. |
destination_profile_system | String | The destination-profile-system of the destination-profile-system. The type of destination profile the test system supports. |
metadata_id | String | The metadata-id of the metadata-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
metadata_extension | String | The metadata-extension of the metadata-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
metadata_modifierExtension | String | The metadata-modifierExtension of the metadata-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
metadata_link_id | String | The metadata-link-id of the metadata-link-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
metadata_link_extension | String | The metadata-link-extension of the metadata-link-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
metadata_link_modifierExtension | String | The metadata-link-modifierExtension of the metadata-link-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
metadata_link_url | String | The metadata-link-url of the metadata-link-url. URL to a particular requirement or feature within the FHIR specification. |
metadata_link_description | String | The metadata-link-description of the metadata-link-description. Short description of the link. |
metadata_capability_id | String | The metadata-capability-id of the metadata-capability-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
metadata_capability_extension | String | The metadata-capability-extension of the metadata-capability-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
metadata_capability_modifierExtension | String | The metadata-capability-modifierExtension of the metadata-capability-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
metadata_capability_required | Bool | The metadata-capability-required of the metadata-capability-required. Whether or not the test execution will require the given capabilities of the server in order for this test script to execute. |
metadata_capability_validated | Bool | The metadata-capability-validated of the metadata-capability-validated. Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute. |
metadata_capability_description | String | The metadata-capability-description of the metadata-capability-description. Description of the capabilities that this test script is requiring the server to support. |
metadata_capability_origin | String | The metadata-capability-origin of the metadata-capability-origin. Which origin server these requirements apply to. |
metadata_capability_destination | Int | The metadata-capability-destination of the metadata-capability-destination. Which server these requirements apply to. |
metadata_capability_link | String | The metadata-capability-link of the metadata-capability-link. Links to the FHIR specification that describes this interaction and the resources involved in more detail. |
metadata_capability_capabilities | String | The metadata-capability-capabilities of the metadata-capability-capabilities. Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped. |
fixture_id | String | The fixture-id of the fixture-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
fixture_extension | String | The fixture-extension of the fixture-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
fixture_modifierExtension | String | The fixture-modifierExtension of the fixture-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
fixture_autocreate | Bool | The fixture-autocreate of the fixture-autocreate. Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section. |
fixture_autodelete | Bool | The fixture-autodelete of the fixture-autodelete. Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section. |
fixture_resource_display | String | The display of the fixture-resource. Reference to the resource (containing the contents of the resource needed for operations). |
fixture_resource_reference | String | The reference of the fixture-resource. Reference to the resource (containing the contents of the resource needed for operations). |
fixture_resource_identifier_value | String | The value of the fixture-resource-identifier. Reference to the resource (containing the contents of the resource needed for operations). |
fixture_resource_type | String | The fixture-resource-type of the fixture-resource-type. Reference to the resource (containing the contents of the resource needed for operations). |
profile_display | String | The display of the profile. Reference to the profile to be used for validation. |
profile_reference | String | The reference of the profile. Reference to the profile to be used for validation. |
profile_identifier_value | String | The value of the profile-identifier. Reference to the profile to be used for validation. |
profile_type | String | The profile-type of the profile-type. Reference to the profile to be used for validation. |
variable_id | String | The variable-id of the variable-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
variable_extension | String | The variable-extension of the variable-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
variable_modifierExtension | String | The variable-modifierExtension of the variable-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
variable_name | String | The variable-name of the variable-name. Descriptive name for this variable. |
variable_defaultValue | String | The variable-defaultValue of the variable-defaultValue. A default, hard-coded, or user-defined value for this variable. |
variable_description | String | The variable-description of the variable-description. A free text natural language description of the variable and its purpose. |
variable_expression | String | The variable-expression of the variable-expression. The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified. |
variable_headerField | String | The variable-headerField of the variable-headerField. Will be used to grab the HTTP header field value from the headers that sourceId is pointing to. |
variable_hint | String | The variable-hint of the variable-hint. Displayable text string with hint help information to the user when entering a default value. |
variable_path | String | The variable-path of the variable-path. XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified. |
variable_sourceId | String | The variable-sourceId of the variable-sourceId. Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable. |
setup_id | String | The setup-id of the setup-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
setup_extension | String | The setup-extension of the setup-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
setup_modifierExtension | String | The setup-modifierExtension of the setup-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
setup_action_id | String | The setup-action-id of the setup-action-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
setup_action_extension | String | The setup-action-extension of the setup-action-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
setup_action_modifierExtension | String | The setup-action-modifierExtension of the setup-action-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
setup_action_operation_id | String | The setup-action-operation-id of the setup-action-operation-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
setup_action_operation_extension | String | The setup-action-operation-extension of the setup-action-operation-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
setup_action_operation_modifierExtension | String | The setup-action-operation-modifierExtension of the setup-action-operation-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
setup_action_operation_type_version | String | The version of the setup-action-operation-type. Server interaction or operation type. |
setup_action_operation_type_code | String | The code of the setup-action-operation-type. Server interaction or operation type. |
setup_action_operation_type_display | String | The display of the setup-action-operation-type. Server interaction or operation type. |
setup_action_operation_type_userSelected | Bool | The userSelected of the setup-action-operation-type. Server interaction or operation type. |
setup_action_operation_type_system | String | The setup-action-operation-type-system of the setup-action-operation-type-system. Server interaction or operation type. |
setup_action_operation_resource | String | The setup-action-operation-resource of the setup-action-operation-resource. The type of the resource. See http://build.fhir.org/resourcelist.html. |
setup_action_operation_label | String | The setup-action-operation-label of the setup-action-operation-label. The label would be used for tracking/logging purposes by test engines. |
setup_action_operation_description | String | The setup-action-operation-description of the setup-action-operation-description. The description would be used by test engines for tracking and reporting purposes. |
setup_action_operation_accept | String | The setup-action-operation-accept of the setup-action-operation-accept. The mime-type to use for RESTful operation in the 'Accept' header. |
setup_action_operation_contentType | String | The setup-action-operation-contentType of the setup-action-operation-contentType. The mime-type to use for RESTful operation in the 'Content-Type' header. |
setup_action_operation_destination | Int | The setup-action-operation-destination of the setup-action-operation-destination. The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section. |
setup_action_operation_encodeRequestUrl | Bool | The setup-action-operation-encodeRequestUrl of the setup-action-operation-encodeRequestUrl. Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths. |
setup_action_operation_method | String | The setup-action-operation-method of the setup-action-operation-method. The HTTP method the test engine MUST use for this operation regardless of any other operation details. |
setup_action_operation_origin | Int | The setup-action-operation-origin of the setup-action-operation-origin. The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section. |
setup_action_operation_params | String | The setup-action-operation-params of the setup-action-operation-params. Path plus parameters after [type]. Used to set parts of the request URL explicitly. |
setup_action_operation_requestHeader_id | String | The setup-action-operation-requestHeader-id of the setup-action-operation-requestHeader-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
setup_action_operation_requestHeader_extension | String | The setup-action-operation-requestHeader-extension of the setup-action-operation-requestHeader-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
setup_action_operation_requestHeader_modifierExtension | String | The setup-action-operation-requestHeader-modifierExtension of the setup-action-operation-requestHeader-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
setup_action_operation_requestHeader_field | String | The setup-action-operation-requestHeader-field of the setup-action-operation-requestHeader-field. The HTTP header field e.g. 'Accept'. |
setup_action_operation_requestHeader_value | String | The setup-action-operation-requestHeader-value of the setup-action-operation-requestHeader-value. The value of the header e.g. 'application/fhir+xml'. |
setup_action_operation_requestId | String | The setup-action-operation-requestId of the setup-action-operation-requestId. The fixture id (maybe new) to map to the request. |
setup_action_operation_responseId | String | The setup-action-operation-responseId of the setup-action-operation-responseId. The fixture id (maybe new) to map to the response. |
setup_action_operation_sourceId | String | The setup-action-operation-sourceId of the setup-action-operation-sourceId. The id of the fixture used as the body of a PUT or POST request. |
setup_action_operation_targetId | String | The setup-action-operation-targetId of the setup-action-operation-targetId. Id of fixture used for extracting the [id], [type], and [vid] for GET requests. |
setup_action_operation_url | String | The setup-action-operation-url of the setup-action-operation-url. Complete request URL. |
setup_action_assert_id | String | The setup-action-assert-id of the setup-action-assert-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
setup_action_assert_extension | String | The setup-action-assert-extension of the setup-action-assert-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
setup_action_assert_modifierExtension | String | The setup-action-assert-modifierExtension of the setup-action-assert-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
setup_action_assert_label | String | The setup-action-assert-label of the setup-action-assert-label. The label would be used for tracking/logging purposes by test engines. |
setup_action_assert_description | String | The setup-action-assert-description of the setup-action-assert-description. The description would be used by test engines for tracking and reporting purposes. |
setup_action_assert_direction | String | The setup-action-assert-direction of the setup-action-assert-direction. The direction to use for the assertion. |
setup_action_assert_compareToSourceId | String | The setup-action-assert-compareToSourceId of the setup-action-assert-compareToSourceId. Id of the source fixture used as the contents to be evaluated by either the 'source/expression' or 'sourceId/path' definition. |
setup_action_assert_compareToSourceExpression | String | The setup-action-assert-compareToSourceExpression of the setup-action-assert-compareToSourceExpression. The FHIRPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both. |
setup_action_assert_compareToSourcePath | String | The setup-action-assert-compareToSourcePath of the setup-action-assert-compareToSourcePath. XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both. |
setup_action_assert_contentType | String | The setup-action-assert-contentType of the setup-action-assert-contentType. The mime-type contents to compare against the request or response message 'Content-Type' header. |
setup_action_assert_expression | String | The setup-action-assert-expression of the setup-action-assert-expression. The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload. |
setup_action_assert_headerField | String | The setup-action-assert-headerField of the setup-action-assert-headerField. The HTTP header field name e.g. 'Location'. |
setup_action_assert_minimumId | String | The setup-action-assert-minimumId of the setup-action-assert-minimumId. The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId. |
setup_action_assert_navigationLinks | Bool | The setup-action-assert-navigationLinks of the setup-action-assert-navigationLinks. Whether or not the test execution performs validation on the bundle navigation links. |
setup_action_assert_operator | String | The setup-action-assert-operator of the setup-action-assert-operator. The operator type defines the conditional behavior of the assert. If not defined, the default is equals. |
setup_action_assert_path | String | The setup-action-assert-path of the setup-action-assert-path. The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server. |
setup_action_assert_requestMethod | String | The setup-action-assert-requestMethod of the setup-action-assert-requestMethod. The request method or HTTP operation code to compare against that used by the client system under test. |
setup_action_assert_requestURL | String | The setup-action-assert-requestURL of the setup-action-assert-requestURL. The value to use in a comparison against the request URL path string. |
setup_action_assert_resource | String | The setup-action-assert-resource of the setup-action-assert-resource. The type of the resource. See http://build.fhir.org/resourcelist.html. |
setup_action_assert_response | String | The setup-action-assert-response of the setup-action-assert-response. okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable. |
setup_action_assert_responseCode | String | The setup-action-assert-responseCode of the setup-action-assert-responseCode. The value of the HTTP response code to be tested. |
setup_action_assert_sourceId | String | The setup-action-assert-sourceId of the setup-action-assert-sourceId. Fixture to evaluate the XPath/JSONPath expression or the headerField against. |
setup_action_assert_validateProfileId | String | The setup-action-assert-validateProfileId of the setup-action-assert-validateProfileId. The ID of the Profile to validate against. |
setup_action_assert_value | String | The setup-action-assert-value of the setup-action-assert-value. The value to compare to. |
setup_action_assert_warningOnly | Bool | The setup-action-assert-warningOnly of the setup-action-assert-warningOnly. Whether or not the test execution will produce a warning only on error for this assert. |
test_id | String | The test-id of the test-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
test_extension | String | The test-extension of the test-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
test_modifierExtension | String | The test-modifierExtension of the test-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
test_name | String | The test-name of the test-name. The name of this test used for tracking/logging purposes by test engines. |
test_description | String | The test-description of the test-description. A short description of the test used by test engines for tracking and reporting purposes. |
test_action_id | String | The test-action-id of the test-action-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
test_action_extension | String | The test-action-extension of the test-action-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
test_action_modifierExtension | String | The test-action-modifierExtension of the test-action-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
SP_context_end | String | The SP_context_end search parameter. |
SP_testscript_capability | String | The SP_testscript_capability search parameter. |
SP_source | String | The SP_source search parameter. |
SP_text | String | The SP_text search parameter. |
SP_content | String | The SP_content search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_jurisdiction_start | String | The SP_jurisdiction_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
SP_context_type_start | String | The SP_context_type_start search parameter. |
SP_context_quantity | String | The SP_context_quantity search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_context_type_value | String | The SP_context_type_value search parameter. |
SP_context_type_quantity | String | The SP_context_type_quantity search parameter. |
SP_context_type_end | String | The SP_context_type_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_context_start | String | The SP_context_start search parameter. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_jurisdiction_end | String | The SP_jurisdiction_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_filter | String | The SP_filter search parameter. |
VerificationResult view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
target_display | String | The display of the target. A resource that was validated. |
target_reference | String | The reference of the target. A resource that was validated. |
target_identifier_value | String | The value of the target-identifier. A resource that was validated. |
target_type | String | The target-type of the target-type. A resource that was validated. |
targetLocation | String | The fhirpath location(s) within the resource that was validated. |
need_coding | String | The coding of the need. The frequency with which the target must be validated (none; initial; periodic). |
need_text | String | The text of the need. The frequency with which the target must be validated (none; initial; periodic). |
status | String | The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed). |
statusDate | Datetime | When the validation status was updated. |
validationType_coding | String | The coding of the validationType. What the target is validated against (nothing; primary source; multiple sources). |
validationType_text | String | The text of the validationType. What the target is validated against (nothing; primary source; multiple sources). |
validationProcess_coding | String | The coding of the validationProcess. The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context). |
validationProcess_text | String | The text of the validationProcess. The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context). |
frequency | String | Frequency of revalidation. |
lastPerformed | Datetime | The date/time validation was last completed (including failed validations). |
nextScheduled | Date | The date when target is next validated, if appropriate. |
failureAction_coding | String | The coding of the failureAction. The result if validation fails (fatal; warning; record only; none). |
failureAction_text | String | The text of the failureAction. The result if validation fails (fatal; warning; record only; none). |
primarySource_id | String | The primarySource-id of the primarySource-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
primarySource_extension | String | The primarySource-extension of the primarySource-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
primarySource_modifierExtension | String | The primarySource-modifierExtension of the primarySource-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
primarySource_who_display | String | The display of the primarySource-who. Reference to the primary source. |
primarySource_who_reference | String | The reference of the primarySource-who. Reference to the primary source. |
primarySource_who_identifier_value | String | The value of the primarySource-who-identifier. Reference to the primary source. |
primarySource_who_type | String | The primarySource-who-type of the primarySource-who-type. Reference to the primary source. |
primarySource_type_coding | String | The coding of the primarySource-type. Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source). |
primarySource_type_text | String | The text of the primarySource-type. Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source). |
primarySource_communicationMethod_coding | String | The coding of the primarySource-communicationMethod. Method for communicating with the primary source (manual; API; Push). |
primarySource_communicationMethod_text | String | The text of the primarySource-communicationMethod. Method for communicating with the primary source (manual; API; Push). |
primarySource_validationStatus_coding | String | The coding of the primarySource-validationStatus. Status of the validation of the target against the primary source (successful; failed; unknown). |
primarySource_validationStatus_text | String | The text of the primarySource-validationStatus. Status of the validation of the target against the primary source (successful; failed; unknown). |
primarySource_validationDate | Datetime | The primarySource-validationDate of the primarySource-validationDate. When the target was validated against the primary source. |
primarySource_canPushUpdates_coding | String | The coding of the primarySource-canPushUpdates. Ability of the primary source to push updates/alerts (yes; no; undetermined). |
primarySource_canPushUpdates_text | String | The text of the primarySource-canPushUpdates. Ability of the primary source to push updates/alerts (yes; no; undetermined). |
primarySource_pushTypeAvailable_coding | String | The coding of the primarySource-pushTypeAvailable. Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source). |
primarySource_pushTypeAvailable_text | String | The text of the primarySource-pushTypeAvailable. Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source). |
attestation_id | String | The attestation-id of the attestation-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
attestation_extension | String | The attestation-extension of the attestation-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
attestation_modifierExtension | String | The attestation-modifierExtension of the attestation-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
attestation_who_display | String | The display of the attestation-who. The individual or organization attesting to information. |
attestation_who_reference | String | The reference of the attestation-who. The individual or organization attesting to information. |
attestation_who_identifier_value | String | The value of the attestation-who-identifier. The individual or organization attesting to information. |
attestation_who_type | String | The attestation-who-type of the attestation-who-type. The individual or organization attesting to information. |
attestation_onBehalfOf_display | String | The display of the attestation-onBehalfOf. When the who is asserting on behalf of another (organization or individual). |
attestation_onBehalfOf_reference | String | The reference of the attestation-onBehalfOf. When the who is asserting on behalf of another (organization or individual). |
attestation_onBehalfOf_identifier_value | String | The value of the attestation-onBehalfOf-identifier. When the who is asserting on behalf of another (organization or individual). |
attestation_onBehalfOf_type | String | The attestation-onBehalfOf-type of the attestation-onBehalfOf-type. When the who is asserting on behalf of another (organization or individual). |
attestation_communicationMethod_coding | String | The coding of the attestation-communicationMethod. The method by which attested information was submitted/retrieved (manual; API; Push). |
attestation_communicationMethod_text | String | The text of the attestation-communicationMethod. The method by which attested information was submitted/retrieved (manual; API; Push). |
attestation_date | Date | The attestation-date of the attestation-date. The date the information was attested to. |
attestation_sourceIdentityCertificate | String | The attestation-sourceIdentityCertificate of the attestation-sourceIdentityCertificate. A digital identity certificate associated with the attestation source. |
attestation_proxyIdentityCertificate | String | The attestation-proxyIdentityCertificate of the attestation-proxyIdentityCertificate. A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source. |
attestation_proxySignature_when | String | The when of the attestation-proxySignature. Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source. |
attestation_proxySignature_data | String | The data of the attestation-proxySignature. Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source. |
attestation_proxySignature_type_version | String | The version of the attestation-proxySignature-type. Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source. |
attestation_proxySignature_type_code | String | The code of the attestation-proxySignature-type. Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source. |
attestation_proxySignature_type_display | String | The display of the attestation-proxySignature-type. Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source. |
attestation_proxySignature_type_userSelected | Bool | The userSelected of the attestation-proxySignature-type. Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source. |
attestation_proxySignature_who_display | String | The display of the attestation-proxySignature-who. Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source. |
attestation_proxySignature_who_reference | String | The reference of the attestation-proxySignature-who. Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source. |
attestation_proxySignature_onBehalfOf_display | String | The display of the attestation-proxySignature-onBehalfOf. Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source. |
attestation_proxySignature_onBehalfOf_reference | String | The reference of the attestation-proxySignature-onBehalfOf. Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source. |
attestation_proxySignature_targetFormat | String | The attestation-proxySignature-targetFormat of the attestation-proxySignature-targetFormat. Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source. |
attestation_proxySignature_sigFormat | String | The attestation-proxySignature-sigFormat of the attestation-proxySignature-sigFormat. Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source. |
attestation_sourceSignature_when | String | The when of the attestation-sourceSignature. Signed assertion by the attestation source that they have attested to the information. |
attestation_sourceSignature_data | String | The data of the attestation-sourceSignature. Signed assertion by the attestation source that they have attested to the information. |
attestation_sourceSignature_type_version | String | The version of the attestation-sourceSignature-type. Signed assertion by the attestation source that they have attested to the information. |
attestation_sourceSignature_type_code | String | The code of the attestation-sourceSignature-type. Signed assertion by the attestation source that they have attested to the information. |
attestation_sourceSignature_type_display | String | The display of the attestation-sourceSignature-type. Signed assertion by the attestation source that they have attested to the information. |
attestation_sourceSignature_type_userSelected | Bool | The userSelected of the attestation-sourceSignature-type. Signed assertion by the attestation source that they have attested to the information. |
attestation_sourceSignature_who_display | String | The display of the attestation-sourceSignature-who. Signed assertion by the attestation source that they have attested to the information. |
attestation_sourceSignature_who_reference | String | The reference of the attestation-sourceSignature-who. Signed assertion by the attestation source that they have attested to the information. |
attestation_sourceSignature_onBehalfOf_display | String | The display of the attestation-sourceSignature-onBehalfOf. Signed assertion by the attestation source that they have attested to the information. |
attestation_sourceSignature_onBehalfOf_reference | String | The reference of the attestation-sourceSignature-onBehalfOf. Signed assertion by the attestation source that they have attested to the information. |
attestation_sourceSignature_targetFormat | String | The attestation-sourceSignature-targetFormat of the attestation-sourceSignature-targetFormat. Signed assertion by the attestation source that they have attested to the information. |
attestation_sourceSignature_sigFormat | String | The attestation-sourceSignature-sigFormat of the attestation-sourceSignature-sigFormat. Signed assertion by the attestation source that they have attested to the information. |
validator_id | String | The validator-id of the validator-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
validator_extension | String | The validator-extension of the validator-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
validator_modifierExtension | String | The validator-modifierExtension of the validator-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
validator_organization_display | String | The display of the validator-organization. Reference to the organization validating information. |
validator_organization_reference | String | The reference of the validator-organization. Reference to the organization validating information. |
validator_organization_identifier_value | String | The value of the validator-organization-identifier. Reference to the organization validating information. |
validator_organization_type | String | The validator-organization-type of the validator-organization-type. Reference to the organization validating information. |
validator_identityCertificate | String | The validator-identityCertificate of the validator-identityCertificate. A digital identity certificate associated with the validator. |
validator_attestationSignature_when | String | The when of the validator-attestationSignature. Signed assertion by the validator that they have validated the information. |
validator_attestationSignature_data | String | The data of the validator-attestationSignature. Signed assertion by the validator that they have validated the information. |
validator_attestationSignature_type_version | String | The version of the validator-attestationSignature-type. Signed assertion by the validator that they have validated the information. |
validator_attestationSignature_type_code | String | The code of the validator-attestationSignature-type. Signed assertion by the validator that they have validated the information. |
validator_attestationSignature_type_display | String | The display of the validator-attestationSignature-type. Signed assertion by the validator that they have validated the information. |
validator_attestationSignature_type_userSelected | Bool | The userSelected of the validator-attestationSignature-type. Signed assertion by the validator that they have validated the information. |
validator_attestationSignature_who_display | String | The display of the validator-attestationSignature-who. Signed assertion by the validator that they have validated the information. |
validator_attestationSignature_who_reference | String | The reference of the validator-attestationSignature-who. Signed assertion by the validator that they have validated the information. |
validator_attestationSignature_onBehalfOf_display | String | The display of the validator-attestationSignature-onBehalfOf. Signed assertion by the validator that they have validated the information. |
validator_attestationSignature_onBehalfOf_reference | String | The reference of the validator-attestationSignature-onBehalfOf. Signed assertion by the validator that they have validated the information. |
validator_attestationSignature_targetFormat | String | The validator-attestationSignature-targetFormat of the validator-attestationSignature-targetFormat. Signed assertion by the validator that they have validated the information. |
validator_attestationSignature_sigFormat | String | The validator-attestationSignature-sigFormat of the validator-attestationSignature-sigFormat. Signed assertion by the validator that they have validated the information. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_target | String | The SP_target search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
VisionPrescription view.
Name | Type | Description |
id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
language | String | The base language in which the resource is written. |
text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
identifier_value | String | The value of the identifier. A unique identifier assigned to this vision prescription. |
identifier_use | String | The identifier-use of the identifier-use. A unique identifier assigned to this vision prescription. |
identifier_type_coding | String | The coding of the identifier-type. A unique identifier assigned to this vision prescription. |
identifier_type_text | String | The text of the identifier-type. A unique identifier assigned to this vision prescription. |
identifier_system | String | The identifier-system of the identifier-system. A unique identifier assigned to this vision prescription. |
identifier_period_start | String | The start of the identifier-period. A unique identifier assigned to this vision prescription. |
identifier_period_end | String | The end of the identifier-period. A unique identifier assigned to this vision prescription. |
status | String | The status of the resource instance. |
created | Datetime | The date this resource was created. |
patient_display | String | The display of the patient. A resource reference to the person to whom the vision prescription applies. |
patient_reference | String | The reference of the patient. A resource reference to the person to whom the vision prescription applies. |
patient_identifier_value | String | The value of the patient-identifier. A resource reference to the person to whom the vision prescription applies. |
patient_type | String | The patient-type of the patient-type. A resource reference to the person to whom the vision prescription applies. |
encounter_display | String | The display of the encounter. A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued. |
encounter_reference | String | The reference of the encounter. A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued. |
encounter_identifier_value | String | The value of the encounter-identifier. A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued. |
encounter_type | String | The encounter-type of the encounter-type. A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued. |
dateWritten | Datetime | The date (and perhaps time) when the prescription was written. |
prescriber_display | String | The display of the prescriber. The healthcare professional responsible for authorizing the prescription. |
prescriber_reference | String | The reference of the prescriber. The healthcare professional responsible for authorizing the prescription. |
prescriber_identifier_value | String | The value of the prescriber-identifier. The healthcare professional responsible for authorizing the prescription. |
prescriber_type | String | The prescriber-type of the prescriber-type. The healthcare professional responsible for authorizing the prescription. |
lensSpecification_id | String | The lensSpecification-id of the lensSpecification-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
lensSpecification_extension | String | The lensSpecification-extension of the lensSpecification-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
lensSpecification_modifierExtension | String | The lensSpecification-modifierExtension of the lensSpecification-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
lensSpecification_product_coding | String | The coding of the lensSpecification-product. Identifies the type of vision correction product which is required for the patient. |
lensSpecification_product_text | String | The text of the lensSpecification-product. Identifies the type of vision correction product which is required for the patient. |
lensSpecification_eye | String | The lensSpecification-eye of the lensSpecification-eye. The eye for which the lens specification applies. |
lensSpecification_sphere | Decimal | The lensSpecification-sphere of the lensSpecification-sphere. Lens power measured in dioptres (0.25 units). |
lensSpecification_cylinder | Decimal | The lensSpecification-cylinder of the lensSpecification-cylinder. Power adjustment for astigmatism measured in dioptres (0.25 units). |
lensSpecification_axis | Int | The lensSpecification-axis of the lensSpecification-axis. Adjustment for astigmatism measured in integer degrees. |
lensSpecification_prism_id | String | The lensSpecification-prism-id of the lensSpecification-prism-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
lensSpecification_prism_extension | String | The lensSpecification-prism-extension of the lensSpecification-prism-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
lensSpecification_prism_modifierExtension | String | The lensSpecification-prism-modifierExtension of the lensSpecification-prism-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
lensSpecification_prism_amount | Decimal | The lensSpecification-prism-amount of the lensSpecification-prism-amount. Amount of prism to compensate for eye alignment in fractional units. |
lensSpecification_prism_base | String | The lensSpecification-prism-base of the lensSpecification-prism-base. The relative base, or reference lens edge, for the prism. |
lensSpecification_add | Decimal | The lensSpecification-add of the lensSpecification-add. Power adjustment for multifocal lenses measured in dioptres (0.25 units). |
lensSpecification_power | Decimal | The lensSpecification-power of the lensSpecification-power. Contact lens power measured in dioptres (0.25 units). |
lensSpecification_backCurve | Decimal | The lensSpecification-backCurve of the lensSpecification-backCurve. Back curvature measured in millimetres. |
lensSpecification_diameter | Decimal | The lensSpecification-diameter of the lensSpecification-diameter. Contact lens diameter measured in millimetres. |
lensSpecification_duration_value | Decimal | The value of the lensSpecification-duration. The recommended maximum wear period for the lens. |
lensSpecification_duration_unit | String | The unit of the lensSpecification-duration. The recommended maximum wear period for the lens. |
lensSpecification_duration_system | String | The system of the lensSpecification-duration. The recommended maximum wear period for the lens. |
lensSpecification_duration_comparator | String | The lensSpecification-duration-comparator of the lensSpecification-duration-comparator. The recommended maximum wear period for the lens. |
lensSpecification_duration_code | String | The lensSpecification-duration-code of the lensSpecification-duration-code. The recommended maximum wear period for the lens. |
lensSpecification_color | String | The lensSpecification-color of the lensSpecification-color. Special color or pattern. |
lensSpecification_brand | String | The lensSpecification-brand of the lensSpecification-brand. Brand recommendations or restrictions. |
lensSpecification_note | String | The lensSpecification-note of the lensSpecification-note. Notes for special requirements such as coatings and lens materials. |
SP_identifier_end | String | The SP_identifier_end search parameter. |
SP_profile | String | The SP_profile search parameter. |
SP_tagSP_end | String | The SP_tagSP_end search parameter. |
SP_list | String | The SP_list search parameter. |
SP_content | String | The SP_content search parameter. |
SP_source | String | The SP_source search parameter. |
SP_filter | String | The SP_filter search parameter. |
SP_text | String | The SP_text search parameter. |
SP_patient | String | The SP_patient search parameter. |
SP_prescriber | String | The SP_prescriber search parameter. |
SP_securitySP_end | String | The SP_securitySP_end search parameter. |
SP_securitySP_start | String | The SP_securitySP_start search parameter. |
SP_encounter | String | The SP_encounter search parameter. |
SP_identifier_start | String | The SP_identifier_start search parameter. |
SP_tagSP_start | String | The SP_tagSP_start search parameter. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
Property | Description |
AuthScheme | The type of authentication to use when connecting to remote services. |
ConnectionType | The type of connection to use. |
User | The FHIR user account used to authenticate. |
Password | The password used to authenticate the user. |
URL | The Service Base URL of the FHIR server. |
APIKey | The API key used for accessing your InterSystems IRIS for Health account. For more reference, please check: https://docs.intersystems.com/services/csp/docbook/DocBook.UI.Page.cls?KEY=FAS_intro#FAS_tour_apikey. |
Property | Description |
AWSAccessKey | Your AWS account access key. This value is accessible from your AWS security credentials page. |
AWSSecretKey | Your AWS account secret key. This value is accessible from your AWS security credentials page. |
AWSRoleARN | The Amazon Resource Name of the role to use when authenticating. |
AWSRegion | The hosting region for your Amazon Web Services. |
AWSUserPoolId | The User Pool Id. |
AWSUserPoolClientAppId | The User Pool Client App Id. |
AWSUserPoolClientAppSecret | Optional. The User Pool Client App Secret. |
AWSIdentityPoolId | The Identity Pool Id. |
Property | Description |
OAuthVersion | The version of OAuth being used. |
OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
State | Optional value for representing extra OAuth state information. |
OAuthPasswordGrantMode | How to pass Client Id and Secret with OAuthGrantType is set to Password. |
OAuthIncludeCallbackURL | Whether to include the callback URL in an access token request. |
OAuthAuthorizationURL | The authorization URL for the OAuth service. |
OAuthAccessTokenURL | The URL to retrieve the OAuth access token from. |
OAuthRefreshTokenURL | The URL to refresh the OAuth token from. |
OAuthRequestTokenURL | The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0. |
AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
AuthKey | The authentication secret used to request and obtain the OAuth Access Token. |
OAuthParams | A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value. |
Property | Description |
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
OAuthJWTIssuer | The issuer of the Java Web Token. |
OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
Property | Description |
SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | The password for the TLS/SSL client certificate. |
SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
Property | Description |
LogModules | Core modules to be included in the log file. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
Property | Description |
APIFieldsNameSeparator | Define the separator of compound filed names in your FHIR Server. |
PaginationLimitName | The PaginationLimitName is used for defining a different name for the limit property in the limit-offset pagination. |
PaginationMode | The type of pagination implemented by the FHIR server. The default value is NextLink. |
PaginationOffsetName | Define a different name for offset property in the limit-offset pagination. |
PaginationSnapshotName | Define the name for the property that identifies the current request snapshot identifier. |
ContentType | The format used for accessing your FHIR Server data. The available values are: XML or JSON. |
CustomHeaders | Other headers as determined by the user (optional). |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PageSize | The maximum size of records returned per page. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
SupportsPostSearchRequests | Indicates whether or not the FHIR Server supports sending URL search params in a POST request body using the 'application/x-www-form-urlencoded' ContentType Header. Note: The InterSystems IRIS for Health does not support search with Post. |
SupportsServerSideLastUpdatedFilter | Indicates whether or not the FHIR Server supports filtering Server-Side resources by the LastUpdated date. The filter must strictly follow the FHIR Specifications, meaning that the query parameter name is: '_lastUpdated' and the datetime precision is exactly as the server sends on the response. Also, the server must implemet filtering with comparison operators as: =, <, <=, >, >=. Example: [baseUrl]/Observation?_lastUpdated=2022-09-19T11:59:52Z For more information, please refer to: https://build.fhir.org/search.html#_lastUpdated . |
SupportsServerSideSorting | Indicates whether or not the FHIR Server supports sorting operation Server-Side. The sorting must strictly follow the FHIR Specifications, meaning that the query parameter name is: '_sort' and by default the sotring will be ASC. If we would like to sort them DESC, the server must accept a '-' before the parameter name. Example: [baseUrl]/Observation?_sort=status,-date,category For more information, please refer to: http://hl7.org/fhir/search.html#_sort . |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
Property | Description |
AuthScheme | The type of authentication to use when connecting to remote services. |
ConnectionType | The type of connection to use. |
User | The FHIR user account used to authenticate. |
Password | The password used to authenticate the user. |
URL | The Service Base URL of the FHIR server. |
APIKey | The API key used for accessing your InterSystems IRIS for Health account. For more reference, please check: https://docs.intersystems.com/services/csp/docbook/DocBook.UI.Page.cls?KEY=FAS_intro#FAS_tour_apikey. |
The type of authentication to use when connecting to remote services.
The following options are generally available to all connections:
The type of connection to use.
Set the ConnectionType to one of the following:
The FHIR user account used to authenticate.
Together with Password, this field is used to authenticate against the FHIR server.
The password used to authenticate the user.
The User and Password are together used to authenticate with the server.
The Service Base URL of the FHIR server.
This is the address where the resources are defined in the FHIR server you would like to connect to. Azure-based, AWS-based, Google-based, and generic FHIR server implementations are supported.
Sample Urls for each implementation are found below:
The API key used for accessing your InterSystems IRIS for Health account. For more reference, please check: https://docs.intersystems.com/services/csp/docbook/DocBook.UI.Page.cls?KEY=FAS_intro#FAS_tour_apikey.
The API key used for accessing your InterSystems IRIS for Health account. For more reference, please check: https://docs.intersystems.com/services/csp/docbook/DocBook.UI.Page.cls?KEY=FAS_intro#FAS_tour_apikey
This section provides a complete list of the AWS Authentication properties you can configure in the connection string for this provider.
Property | Description |
AWSAccessKey | Your AWS account access key. This value is accessible from your AWS security credentials page. |
AWSSecretKey | Your AWS account secret key. This value is accessible from your AWS security credentials page. |
AWSRoleARN | The Amazon Resource Name of the role to use when authenticating. |
AWSRegion | The hosting region for your Amazon Web Services. |
AWSUserPoolId | The User Pool Id. |
AWSUserPoolClientAppId | The User Pool Client App Id. |
AWSUserPoolClientAppSecret | Optional. The User Pool Client App Secret. |
AWSIdentityPoolId | The Identity Pool Id. |
Your AWS account access key. This value is accessible from your AWS security credentials page.
Your AWS account access key. This value is accessible from your AWS security credentials page:
Your AWS account secret key. This value is accessible from your AWS security credentials page.
Your AWS account secret key. This value is accessible from your AWS security credentials page:
The Amazon Resource Name of the role to use when authenticating.
When authenticating outside of AWS, it is common to use a Role for authentication instead of your direct AWS account credentials. Entering the AWSRoleARN will cause the CData Sync App to perform a role based authentication instead of using the AWSAccessKey and AWSSecretKey directly. The AWSAccessKey and AWSSecretKey must still be specified to perform this authentication. You cannot use the credentials of an AWS root user when setting RoleARN. The AWSAccessKey and AWSSecretKey must be those of an IAM user.
The hosting region for your Amazon Web Services.
The hosting region for your Amazon Web Services. Available values are OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, JAKARTA, MUMBAI, OSAKA, SEOUL, SINGAPORE, SYDNEY, TOKYO, CENTRAL, BEIJING, NINGXIA, FRANKFURT, IRELAND, LONDON, MILAN, PARIS, STOCKHOLM, ZURICH, BAHRAIN, UAE, SAOPAULO, GOVCLOUDEAST, and GOVCLOUDWEST.
The User Pool Id.
You can find this in AWS Cognito -> Manage User Pools -> select your user pool -> General settings -> Pool Id.
The User Pool Client App Id.
You can find this in AWS Cognito -> Manage Identity Pools -> select your user pool -> General settings -> App clients -> App client Id.
Optional. The User Pool Client App Secret.
You can find this in AWS Cognito -> Manage Identity Pools -> select your user pool -> General settings -> App clients -> App client secret.
The Identity Pool Id.
You can find this in AWS Cognito -> Manage Identity Pools -> select your identity pool -> Edit identity pool -> Identity Pool Id
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
Property | Description |
OAuthVersion | The version of OAuth being used. |
OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
State | Optional value for representing extra OAuth state information. |
OAuthPasswordGrantMode | How to pass Client Id and Secret with OAuthGrantType is set to Password. |
OAuthIncludeCallbackURL | Whether to include the callback URL in an access token request. |
OAuthAuthorizationURL | The authorization URL for the OAuth service. |
OAuthAccessTokenURL | The URL to retrieve the OAuth access token from. |
OAuthRefreshTokenURL | The URL to refresh the OAuth token from. |
OAuthRequestTokenURL | The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0. |
AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
AuthKey | The authentication secret used to request and obtain the OAuth Access Token. |
OAuthParams | A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value. |
The version of OAuth being used.
The version of OAuth being used. The following options are available: 1.0,2.0
The client Id assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
The client secret assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
Optional value for representing extra OAuth state information.
Optional value for representing extra OAuth state information.
How to pass Client Id and Secret with OAuthGrantType is set to Password.
The OAuth RFC specifies two methods of passing the OAuthClientId and OAuthClientSecret when using the Password OAuthGrantType. The most commonly used is to pass them via post data to the service. However, some services may require that you pass them via the Authorize header as to be used in BASIC authorization. Change this property to Basic to submit the parameters as part of the Authorize header instead of the post data.
Whether to include the callback URL in an access token request.
This defaults to true since standards-compliant OAuth services will ignore the redirect_uri parameter for grant types like CLIENT or PASSWORD that do not require it.
This option should only be enabled for OAuth services that report errors when redirect_uri is included.
The authorization URL for the OAuth service.
The authorization URL for the OAuth service. At this URL, the user logs into the server and grants permissions to the application. In OAuth 1.0, if permissions are granted, the request token is authorized.
The URL to retrieve the OAuth access token from.
The URL to retrieve the OAuth access token from. In OAuth 1.0, the authorized request token is exchanged for the access token at this URL.
The URL to refresh the OAuth token from.
The URL to refresh the OAuth token from. In OAuth 2.0, this URL is where the refresh token is exchanged for a new access token when the old access token expires.
The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0.
The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0. In OAuth 1.0, this is the URL where the app makes a request for the request token.
The authentication token used to request and obtain the OAuth Access Token.
This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.
It can be supplied alongside the AuthKey in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.
The authentication secret used to request and obtain the OAuth Access Token.
This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.
It can be supplied alongside the AuthToken in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.
A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.
A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.
This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.
Property | Description |
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
OAuthJWTIssuer | The issuer of the Java Web Token. |
OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
The JWT Certificate store.
The name of the certificate store for the client certificate.
The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.
OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
The type of key store containing the JWT Certificate.
This property can take one of the following values:
USER | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
MACHINE | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java. |
JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java. |
PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
GOOGLEJSON | The certificate store is the name of a JSON file containing the service account information. Only valid when connecting to a Google service. |
GOOGLEJSONBLOB | The certificate store is a string that contains the service account JSON. Only valid when connecting to a Google service. |
The password for the OAuth JWT certificate.
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys are not encrypted.
The subject of the OAuth JWT certificate.
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
The issuer of the Java Web Token.
The issuer of the Java Web Token. Enter the value of a delegated user Email Address.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.
The issuer of the Java Web Token. Enter the value of a delegated user Email Address.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.
The user subject for which the application is requesting delegated access.
The user subject for which the application is requesting delegated access. Enter the value of the Service Account Email.
The user subject for which the application is requesting delegated access. Enter the value of the Service Account Email.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
Property | Description |
SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | The password for the TLS/SSL client certificate. |
SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
The name of the certificate store for the client certificate.
The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.
SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).
The type of key store containing the TLS/SSL client certificate.
This property can take one of the following values:
USER - default | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java. |
MACHINE | For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java. |
PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java. |
JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java. |
PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE | The certificate store is the name of a file that contains a PuTTY Private Key (PPK). |
XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
The password for the TLS/SSL client certificate.
If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.
The subject of the TLS/SSL client certificate.
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, [email protected]". The common fields and their meanings are shown below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
The certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
Type | Default Port | Description |
TUNNEL | 80 | When this is set, the Sync App opens a connection to FHIR and traffic flows back and forth through the proxy. |
SOCKS4 | 1080 | When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
SOCKS5 | 1080 | When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not.
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
AUTO | Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
ALWAYS | The connection is always SSL enabled. |
NEVER | The connection is not SSL enabled. |
TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
LogModules | Core modules to be included in the log file. |
Core modules to be included in the log file.
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\FHIR Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
APIFieldsNameSeparator | Define the separator of compound filed names in your FHIR Server. |
PaginationLimitName | The PaginationLimitName is used for defining a different name for the limit property in the limit-offset pagination. |
PaginationMode | The type of pagination implemented by the FHIR server. The default value is NextLink. |
PaginationOffsetName | Define a different name for offset property in the limit-offset pagination. |
PaginationSnapshotName | Define the name for the property that identifies the current request snapshot identifier. |
ContentType | The format used for accessing your FHIR Server data. The available values are: XML or JSON. |
CustomHeaders | Other headers as determined by the user (optional). |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PageSize | The maximum size of records returned per page. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
SupportsPostSearchRequests | Indicates whether or not the FHIR Server supports sending URL search params in a POST request body using the 'application/x-www-form-urlencoded' ContentType Header. Note: The InterSystems IRIS for Health does not support search with Post. |
SupportsServerSideLastUpdatedFilter | Indicates whether or not the FHIR Server supports filtering Server-Side resources by the LastUpdated date. The filter must strictly follow the FHIR Specifications, meaning that the query parameter name is: '_lastUpdated' and the datetime precision is exactly as the server sends on the response. Also, the server must implemet filtering with comparison operators as: =, <, <=, >, >=. Example: [baseUrl]/Observation?_lastUpdated=2022-09-19T11:59:52Z For more information, please refer to: https://build.fhir.org/search.html#_lastUpdated . |
SupportsServerSideSorting | Indicates whether or not the FHIR Server supports sorting operation Server-Side. The sorting must strictly follow the FHIR Specifications, meaning that the query parameter name is: '_sort' and by default the sotring will be ASC. If we would like to sort them DESC, the server must accept a '-' before the parameter name. Example: [baseUrl]/Observation?_sort=status,-date,category For more information, please refer to: http://hl7.org/fhir/search.html#_sort . |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Define the separator of compound filed names in your FHIR Server.
Define the separator of compound filed names in your FHIR Server. For example: address-postalcode. In this case it uses '-' as separator. The default valuse is '-'.
The PaginationLimitName is used for defining a different name for the limit property in the limit-offset pagination.
The default value is '_count'.
The type of pagination implemented by the FHIR server. The default value is NextLink.
The following options are generally available to all connections:
Define a different name for offset property in the limit-offset pagination.
The default value is '_search_offset'.
Define the name for the property that identifies the current request snapshot identifier.
This value must be returned on each request under id property. The default value is empty, meaning that the API does not have the snapshot feature and the pagination is a simple limit-offset.
The format used for accessing your FHIR Server data. The available values are: XML or JSON.
By default(AUTO mode) the driver tries to get data in JSON mode, if the server return an error then we set contentType to XML.
Other headers as determined by the user (optional).
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties, like ContentType, From, and so on.
The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by the carriage return and line feed (CRLF) characters.
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for fine-tuning the functionality of the Sync App to integrate with specialized or nonstandard APIs.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
These hidden properties are used only in specific use cases.
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
The maximum size of records returned per page.
Note: The maximum size of records returned per page. Default value is 1000.
This property indicates whether or not to include pseudo columns as columns to the table.
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
Indicates whether or not the FHIR Server supports sending URL search params in a POST request body using the 'application/x-www-form-urlencoded' ContentType Header. Note: The InterSystems IRIS for Health does not support search with Post.
This is helpful in cases where we have a large set of filters and risk reaching the URL max length limit. By default this is set to false. Note: The InterSystems IRIS for Health does not support search with Post.
Indicates whether or not the FHIR Server supports filtering Server-Side resources by the LastUpdated date. The filter must strictly follow the FHIR Specifications, meaning that the query parameter name is: '_lastUpdated' and the datetime precision is exactly as the server sends on the response. Also, the server must implemet filtering with comparison operators as: =, <, <=, >, >=. Example: [baseUrl]/Observation?_lastUpdated=2022-09-19T11:59:52Z For more information, please refer to: https://build.fhir.org/search.html#_lastUpdated .
Indicates whether or not the FHIR Server supports filtering Server-Side resources by the LastUpdated date. The filter must strictly follow the FHIR Specifications, meaning that the query parameter name is: '_lastUpdated' and the datetime precision is exactly as the server sends on the response. Also, the server must implemet filtering with comparison operators as: =, <, <=, >, >=. Example: [baseUrl]/Observation?_lastUpdated=2022-09-19T11:59:52Z For more information, please refer to: FHIR LastUpdated Specifications
Indicates whether or not the FHIR Server supports sorting operation Server-Side. The sorting must strictly follow the FHIR Specifications, meaning that the query parameter name is: '_sort' and by default the sotring will be ASC. If we would like to sort them DESC, the server must accept a '-' before the parameter name. Example: [baseUrl]/Observation?_sort=status,-date,category For more information, please refer to: http://hl7.org/fhir/search.html#_sort .
Indicates whether or not the FHIR Server supports sorting operation Server-Side. The sorting must strictly follow the FHIR Specifications, meaning that the query parameter name is: '_sort' and by default the sotring will be ASC. If we would like to sort them DESC, the server must accept a '-' before the parameter name. Example: [baseUrl]/Observation?_sort=status,-date,category For more information, please refer to: FHIR Sorting Specifications
The value in seconds until the timeout error is thrown, canceling the operation.
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Sync App throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.
This User Defined View configuration file is formatted as follows:
For example:
{ "MyView": { "query": "SELECT * FROM Patient WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.jsonNote that the specified path is not embedded in quotation marks.