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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*		This is a VerificationResult resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri	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	code	The base language in which the resource is written.
text	Narrative	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	array(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.
extension	array(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.
modifierExtension	array(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).
target	array(Reference)	A resource that was validated.
targetLocation	array(string)	The fhirpath location(s) within the resource that was validated.
need	CodeableConcept	The frequency with which the target must be validated (none; initial; periodic).
status	code	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	CodeableConcept	What the target is validated against (nothing; primary source; multiple sources).
validationProcess	array(CodeableConcept)	The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).
frequency	Timing	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	CodeableConcept	The result if validation fails (fatal; warning; record only; none).
primarySource	array(VerificationResult_PrimarySource)	Information about the primary source(s) involved in validation.
attestation	VerificationResult_Attestation	Information about the entity attesting to information.
validator	array(VerificationResult_Validator)	Information about the entity validating information.

Response

201 400 401 404

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*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*		This is a VerificationResult resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri	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	code	The base language in which the resource is written.
text	Narrative	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	array(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.
extension	array(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.
modifierExtension	array(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).
target	array(Reference)	A resource that was validated.
targetLocation	array(string)	The fhirpath location(s) within the resource that was validated.
need	CodeableConcept	The frequency with which the target must be validated (none; initial; periodic).
status	code	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	CodeableConcept	What the target is validated against (nothing; primary source; multiple sources).
validationProcess	array(CodeableConcept)	The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).
frequency	Timing	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	CodeableConcept	The result if validation fails (fatal; warning; record only; none).
primarySource	array(VerificationResult_PrimarySource)	Information about the primary source(s) involved in validation.
attestation	VerificationResult_Attestation	Information about the entity attesting to information.
validator	array(VerificationResult_Validator)	Information about the entity validating information.

Response

200 201 400 401 404 409

Read Verification Result

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Verification Result

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Verification Result

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Verification Result

delete

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Verification Result

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
target	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Verification Result

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

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*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
target	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*		This is a VerificationResult resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri	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	code	The base language in which the resource is written.
text	Narrative	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	array(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.
extension	array(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.
modifierExtension	array(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).
target	array(Reference)	A resource that was validated.
targetLocation	array(string)	The fhirpath location(s) within the resource that was validated.
need	CodeableConcept	The frequency with which the target must be validated (none; initial; periodic).
status	code	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	CodeableConcept	What the target is validated against (nothing; primary source; multiple sources).
validationProcess	array(CodeableConcept)	The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).
frequency	Timing	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	CodeableConcept	The result if validation fails (fatal; warning; record only; none).
primarySource	array(VerificationResult_PrimarySource)	Information about the primary source(s) involved in validation.
attestation	VerificationResult_Attestation	Information about the entity attesting to information.
validator	array(VerificationResult_Validator)	Information about the entity validating information.

Response

200 401 404

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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*		This is a VerificationResult resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri	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	code	The base language in which the resource is written.
text	Narrative	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	array(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.
extension	array(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.
modifierExtension	array(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).
target	array(Reference)	A resource that was validated.
targetLocation	array(string)	The fhirpath location(s) within the resource that was validated.
need	CodeableConcept	The frequency with which the target must be validated (none; initial; periodic).
status	code	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	CodeableConcept	What the target is validated against (nothing; primary source; multiple sources).
validationProcess	array(CodeableConcept)	The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).
frequency	Timing	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	CodeableConcept	The result if validation fails (fatal; warning; record only; none).
primarySource	array(VerificationResult_PrimarySource)	Information about the primary source(s) involved in validation.
attestation	VerificationResult_Attestation	Information about the entity attesting to information.
validator	array(VerificationResult_Validator)	Information about the entity validating information.

Response

200 201 400 401 404 409