verification results

Create Verification Result

post
/organizations/{organizationId}/fhir/4/VerificationResult

Describes validation requirements, source(s), status and dates for one or more elements.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a VerificationResult resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)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).
targetarray(Reference)A resource that was validated.
targetLocationarray(string)The fhirpath location(s) within the resource that was validated.
needCodeableConceptThe frequency with which the target must be validated (none; initial; periodic).
statuscodeThe validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).
statusDatedateTimeWhen the validation status was updated.
validationTypeCodeableConceptWhat the target is validated against (nothing; primary source; multiple sources).
validationProcessarray(CodeableConcept)The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).
frequencyTimingFrequency of revalidation.
lastPerformeddateTimeThe date/time validation was last completed (including failed validations).
nextScheduleddateThe date when target is next validated, if appropriate.
failureActionCodeableConceptThe result if validation fails (fatal; warning; record only; none).
primarySourcearray(VerificationResult_PrimarySource)Information about the primary source(s) involved in validation.
attestationVerificationResult_AttestationInformation about the entity attesting to information.
validatorarray(VerificationResult_Validator)Information about the entity validating information.

Response

Patch Verification Result

patch
/organizations/{organizationId}/fhir/4/VerificationResult/{resourceId}

Describes validation requirements, source(s), status and dates for one or more elements.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a VerificationResult resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)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).
targetarray(Reference)A resource that was validated.
targetLocationarray(string)The fhirpath location(s) within the resource that was validated.
needCodeableConceptThe frequency with which the target must be validated (none; initial; periodic).
statuscodeThe validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).
statusDatedateTimeWhen the validation status was updated.
validationTypeCodeableConceptWhat the target is validated against (nothing; primary source; multiple sources).
validationProcessarray(CodeableConcept)The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).
frequencyTimingFrequency of revalidation.
lastPerformeddateTimeThe date/time validation was last completed (including failed validations).
nextScheduleddateThe date when target is next validated, if appropriate.
failureActionCodeableConceptThe result if validation fails (fatal; warning; record only; none).
primarySourcearray(VerificationResult_PrimarySource)Information about the primary source(s) involved in validation.
attestationVerificationResult_AttestationInformation about the entity attesting to information.
validatorarray(VerificationResult_Validator)Information about the entity validating information.

Response

Read Verification Result

get
/organizations/{organizationId}/fhir/4/VerificationResult/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Verification Result

get
/organizations/{organizationId}/fhir/4/VerificationResult/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Verification Result

get
/organizations/{organizationId}/fhir/4/VerificationResult/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Verification Result

delete
/organizations/{organizationId}/fhir/4/VerificationResult/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Verification Result

get
/organizations/{organizationId}/fhir/4/VerificationResult

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
targetstring

Params

organizationId*string|stringid|slug

Response

Search History Verification Result

get
/organizations/{organizationId}/fhir/4/VerificationResult/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Verification Result

post
/organizations/{organizationId}/fhir/4/VerificationResult/_search

Describes validation requirements, source(s), status and dates for one or more elements.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
targetstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a VerificationResult resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)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).
targetarray(Reference)A resource that was validated.
targetLocationarray(string)The fhirpath location(s) within the resource that was validated.
needCodeableConceptThe frequency with which the target must be validated (none; initial; periodic).
statuscodeThe validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).
statusDatedateTimeWhen the validation status was updated.
validationTypeCodeableConceptWhat the target is validated against (nothing; primary source; multiple sources).
validationProcessarray(CodeableConcept)The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).
frequencyTimingFrequency of revalidation.
lastPerformeddateTimeThe date/time validation was last completed (including failed validations).
nextScheduleddateThe date when target is next validated, if appropriate.
failureActionCodeableConceptThe result if validation fails (fatal; warning; record only; none).
primarySourcearray(VerificationResult_PrimarySource)Information about the primary source(s) involved in validation.
attestationVerificationResult_AttestationInformation about the entity attesting to information.
validatorarray(VerificationResult_Validator)Information about the entity validating information.

Response

Update Verification Result

put
/organizations/{organizationId}/fhir/4/VerificationResult/{resourceId}

Describes validation requirements, source(s), status and dates for one or more elements.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a VerificationResult resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)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).
targetarray(Reference)A resource that was validated.
targetLocationarray(string)The fhirpath location(s) within the resource that was validated.
needCodeableConceptThe frequency with which the target must be validated (none; initial; periodic).
statuscodeThe validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).
statusDatedateTimeWhen the validation status was updated.
validationTypeCodeableConceptWhat the target is validated against (nothing; primary source; multiple sources).
validationProcessarray(CodeableConcept)The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).
frequencyTimingFrequency of revalidation.
lastPerformeddateTimeThe date/time validation was last completed (including failed validations).
nextScheduleddateThe date when target is next validated, if appropriate.
failureActionCodeableConceptThe result if validation fails (fatal; warning; record only; none).
primarySourcearray(VerificationResult_PrimarySource)Information about the primary source(s) involved in validation.
attestationVerificationResult_AttestationInformation about the entity attesting to information.
validatorarray(VerificationResult_Validator)Information about the entity validating information.

Response