R4 Draft for Comment
AdministrationThis page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Patient Administration Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
StructureDefinition for verificationresult
{
"resourceType": "StructureDefinition",
"id": "VerificationResult",
"meta": {
"lastUpdated": "2017-12-20T15:52:34.818+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pa"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/VerificationResult",
"name": "VerificationResult",
"status": "draft",
"date": "2017-12-20T15:52:34+11:00",
"publisher": "Health Level Seven International (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Describes validation requirements, source(s), status and dates for one or more elements.",
"fhirVersion": "3.2.0",
"mapping": [
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "VerificationResult",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "VerificationResult",
"path": "VerificationResult",
"short": "Describes validation requirements, source(s), status and dates for one or more elements",
"definition": "Describes validation requirements, source(s), status and dates for one or more elements.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::reference[@value='#'])]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "w5",
"map": "administrative.entity"
}
]
},
{
"id": "VerificationResult.id",
"path": "VerificationResult.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "VerificationResult.meta",
"path": "VerificationResult.meta",
"short": "Metadata about the resource",
"definition": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "VerificationResult.implicitRules",
"path": "VerificationResult.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "VerificationResult.language",
"path": "VerificationResult.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "VerificationResult.text",
"path": "VerificationResult.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. 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.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "VerificationResult.contained",
"path": "VerificationResult.contained",
"short": "Contained, inline Resources",
"definition": "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.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "VerificationResult.extension",
"path": "VerificationResult.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "VerificationResult.modifierExtension",
"path": "VerificationResult.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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. Usually modifier elements provide negation or qualification. In order to make the 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "VerificationResult.target",
"path": "VerificationResult.target",
"short": "A resource that was validated",
"definition": "A resource that was validated.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true
},
{
"id": "VerificationResult.targetLocation",
"path": "VerificationResult.targetLocation",
"short": "The fhirpath location(s) within the resource that was validated",
"definition": "The fhirpath location(s) within the resource that was validated.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "VerificationResult.need",
"path": "VerificationResult.need",
"short": "none | initial | periodic",
"definition": "The frequency with which the target must be validated (none; initial; periodic).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "need"
}
],
"strength": "required",
"description": "The frequency with which the target must be validated",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/need"
}
}
},
{
"id": "VerificationResult.status",
"path": "VerificationResult.status",
"short": "attested | validated | in-process | req-revalid | val-fail | reval-fail",
"definition": "The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "status"
}
],
"strength": "required",
"description": "The validation status of the target",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/status"
}
}
},
{
"id": "VerificationResult.statusDate",
"path": "VerificationResult.statusDate",
"short": "When the validation status was updated",
"definition": "When the validation status was updated.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"id": "VerificationResult.validationType",
"path": "VerificationResult.validationType",
"short": "nothing | primary | multiple",
"definition": "What the target is validated against (nothing; primary source; multiple sources).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "validation-type"
}
],
"strength": "required",
"description": "What the target is validated against",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/validation-type"
}
}
},
{
"id": "VerificationResult.validationProcess",
"path": "VerificationResult.validationProcess",
"short": "The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)",
"definition": "The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).",
"min": 1,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "validation-process"
}
],
"strength": "example",
"description": "The primary process by which the target is validated",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/validation-process"
}
}
},
{
"id": "VerificationResult.frequency",
"path": "VerificationResult.frequency",
"short": "Frequency of revalidation",
"definition": "Frequency of revalidation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
]
},
{
"id": "VerificationResult.lastPerformed",
"path": "VerificationResult.lastPerformed",
"short": "The date/time validation was last completed (incl. failed validations)",
"definition": "The date/time validation was last completed (incl. failed validations).",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "VerificationResult.nextScheduled",
"path": "VerificationResult.nextScheduled",
"short": "The date when target is next validated, if appropriate",
"definition": "The date when target is next validated, if appropriate.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "VerificationResult.failureAction",
"path": "VerificationResult.failureAction",
"short": "fatal | warn | rec-only | none",
"definition": "The result if validation fails (fatal; warning; record only; none).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "failure-action"
}
],
"strength": "required",
"description": "The result if validation fails",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/failure-action"
}
}
},
{
"id": "VerificationResult.primarySource",
"path": "VerificationResult.primarySource",
"short": "Information about the primary source(s) involved in validation",
"definition": "Information about the primary source(s) involved in validation.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "VerificationResult.primarySource.id",
"path": "VerificationResult.primarySource.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VerificationResult.primarySource.extension",
"path": "VerificationResult.primarySource.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VerificationResult.primarySource.modifierExtension",
"path": "VerificationResult.primarySource.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "VerificationResult.primarySource.identifier",
"path": "VerificationResult.primarySource.identifier",
"short": "URI of the primary source for validation",
"definition": "URI of the primary source for validation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "VerificationResult.primarySource.organization",
"path": "VerificationResult.primarySource.organization",
"short": "Reference to the primary source",
"definition": "Reference to the primary source.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"id": "VerificationResult.primarySource.type",
"path": "VerificationResult.primarySource.type",
"short": "Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)",
"definition": "Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).",
"min": 1,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "primary-source-type"
}
],
"strength": "example",
"description": "Type of the validation primary source",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/primary-source-type"
}
}
},
{
"id": "VerificationResult.primarySource.validationProcess",
"path": "VerificationResult.primarySource.validationProcess",
"short": "Method for communicating with the primary source (manual; API; Push)",
"definition": "Method for communicating with the primary source (manual; API; Push).",
"min": 1,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "VerificationResult.primarySource.validationStatus",
"path": "VerificationResult.primarySource.validationStatus",
"short": "successful | failed | unknown",
"definition": "Status of the validation of the target against the primary source (successful; failed; unknown).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "validation-status"
}
],
"strength": "required",
"description": "Status of the validation of the target against the primary source",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/validation-status"
}
}
},
{
"id": "VerificationResult.primarySource.validationDate",
"path": "VerificationResult.primarySource.validationDate",
"short": "When the target was validated against the primary source",
"definition": "When the target was validated against the primary source.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "VerificationResult.primarySource.canPushUpdates",
"path": "VerificationResult.primarySource.canPushUpdates",
"short": "yes | no | undetermined",
"definition": "Ability of the primary source to push updates/alerts (yes; no; undetermined).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "can-push-updates"
}
],
"strength": "required",
"description": "Ability of the primary source to push updates/alerts",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/can-push-updates"
}
}
},
{
"id": "VerificationResult.primarySource.pushTypeAvailable",
"path": "VerificationResult.primarySource.pushTypeAvailable",
"short": "specific | any | source",
"definition": "Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "push-type-available"
}
],
"strength": "required",
"description": "Type of alerts/updates the primary source can send",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/push-type-available"
}
}
},
{
"id": "VerificationResult.attestation",
"path": "VerificationResult.attestation",
"short": "Information about the entity attesting to information",
"definition": "Information about the entity attesting to information.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "VerificationResult.attestation.id",
"path": "VerificationResult.attestation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VerificationResult.attestation.extension",
"path": "VerificationResult.attestation.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VerificationResult.attestation.modifierExtension",
"path": "VerificationResult.attestation.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "VerificationResult.attestation.source",
"path": "VerificationResult.attestation.source",
"short": "The individual attesting to information",
"definition": "The individual attesting to information.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true
},
{
"id": "VerificationResult.attestation.organization",
"path": "VerificationResult.attestation.organization",
"short": "The organization attesting to information",
"definition": "The organization attesting to information.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true
},
{
"id": "VerificationResult.attestation.method",
"path": "VerificationResult.attestation.method",
"short": "Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)",
"definition": "Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "VerificationResult.attestation.date",
"path": "VerificationResult.attestation.date",
"short": "The date the information was attested to",
"definition": "The date the information was attested to.",
"min": 1,
"max": "1",
"type": [
{
"code": "date"
}
],
"isSummary": true
},
{
"id": "VerificationResult.attestation.sourceIdentityCertificate",
"path": "VerificationResult.attestation.sourceIdentityCertificate",
"short": "A digital identity certificate associated with the attestation source",
"definition": "A digital identity certificate associated with the attestation source.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "VerificationResult.attestation.proxyIdentityCertificate",
"path": "VerificationResult.attestation.proxyIdentityCertificate",
"short": "A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source",
"definition": "A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "VerificationResult.validator",
"path": "VerificationResult.validator",
"short": "Information about the entity validating information",
"definition": "Information about the entity validating information.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "VerificationResult.validator.id",
"path": "VerificationResult.validator.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VerificationResult.validator.extension",
"path": "VerificationResult.validator.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VerificationResult.validator.modifierExtension",
"path": "VerificationResult.validator.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "VerificationResult.validator.identifier",
"path": "VerificationResult.validator.identifier",
"short": "URI of the validator",
"definition": "URI of the validator.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "VerificationResult.validator.organization",
"path": "VerificationResult.validator.organization",
"short": "Reference to the organization validating information",
"definition": "Reference to the organization validating information.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"id": "VerificationResult.validator.identityCertificate",
"path": "VerificationResult.validator.identityCertificate",
"short": "A digital identity certificate associated with the validator",
"definition": "A digital identity certificate associated with the validator.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "VerificationResult.validator.dateValidated",
"path": "VerificationResult.validator.dateValidated",
"short": "Date on which the validator last validated the information",
"definition": "Date on which the validator last validated the information.",
"min": 1,
"max": "1",
"type": [
{
"code": "date"
}
]
}
]
},
"differential": {
"element": [
{
"id": "VerificationResult",
"path": "VerificationResult",
"short": "Describes validation requirements, source(s), status and dates for one or more elements",
"definition": "Describes validation requirements, source(s), status and dates for one or more elements.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "w5",
"map": "administrative.entity"
}
]
},
{
"id": "VerificationResult.target",
"path": "VerificationResult.target",
"short": "A resource that was validated",
"definition": "A resource that was validated.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true
},
{
"id": "VerificationResult.targetLocation",
"path": "VerificationResult.targetLocation",
"short": "The fhirpath location(s) within the resource that was validated",
"definition": "The fhirpath location(s) within the resource that was validated.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "VerificationResult.need",
"path": "VerificationResult.need",
"short": "none | initial | periodic",
"definition": "The frequency with which the target must be validated (none; initial; periodic).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "need"
}
],
"strength": "required",
"description": "The frequency with which the target must be validated",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/need"
}
}
},
{
"id": "VerificationResult.status",
"path": "VerificationResult.status",
"short": "attested | validated | in-process | req-revalid | val-fail | reval-fail",
"definition": "The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "status"
}
],
"strength": "required",
"description": "The validation status of the target",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/status"
}
}
},
{
"id": "VerificationResult.statusDate",
"path": "VerificationResult.statusDate",
"short": "When the validation status was updated",
"definition": "When the validation status was updated.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"id": "VerificationResult.validationType",
"path": "VerificationResult.validationType",
"short": "nothing | primary | multiple",
"definition": "What the target is validated against (nothing; primary source; multiple sources).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "validation-type"
}
],
"strength": "required",
"description": "What the target is validated against",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/validation-type"
}
}
},
{
"id": "VerificationResult.validationProcess",
"path": "VerificationResult.validationProcess",
"short": "The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)",
"definition": "The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).",
"min": 1,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "validation-process"
}
],
"strength": "example",
"description": "The primary process by which the target is validated",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/validation-process"
}
}
},
{
"id": "VerificationResult.frequency",
"path": "VerificationResult.frequency",
"short": "Frequency of revalidation",
"definition": "Frequency of revalidation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
]
},
{
"id": "VerificationResult.lastPerformed",
"path": "VerificationResult.lastPerformed",
"short": "The date/time validation was last completed (incl. failed validations)",
"definition": "The date/time validation was last completed (incl. failed validations).",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "VerificationResult.nextScheduled",
"path": "VerificationResult.nextScheduled",
"short": "The date when target is next validated, if appropriate",
"definition": "The date when target is next validated, if appropriate.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "VerificationResult.failureAction",
"path": "VerificationResult.failureAction",
"short": "fatal | warn | rec-only | none",
"definition": "The result if validation fails (fatal; warning; record only; none).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "failure-action"
}
],
"strength": "required",
"description": "The result if validation fails",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/failure-action"
}
}
},
{
"id": "VerificationResult.primarySource",
"path": "VerificationResult.primarySource",
"short": "Information about the primary source(s) involved in validation",
"definition": "Information about the primary source(s) involved in validation.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "VerificationResult.primarySource.identifier",
"path": "VerificationResult.primarySource.identifier",
"short": "URI of the primary source for validation",
"definition": "URI of the primary source for validation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "VerificationResult.primarySource.organization",
"path": "VerificationResult.primarySource.organization",
"short": "Reference to the primary source",
"definition": "Reference to the primary source.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"id": "VerificationResult.primarySource.type",
"path": "VerificationResult.primarySource.type",
"short": "Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)",
"definition": "Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).",
"min": 1,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "primary-source-type"
}
],
"strength": "example",
"description": "Type of the validation primary source",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/primary-source-type"
}
}
},
{
"id": "VerificationResult.primarySource.validationProcess",
"path": "VerificationResult.primarySource.validationProcess",
"short": "Method for communicating with the primary source (manual; API; Push)",
"definition": "Method for communicating with the primary source (manual; API; Push).",
"min": 1,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "VerificationResult.primarySource.validationStatus",
"path": "VerificationResult.primarySource.validationStatus",
"short": "successful | failed | unknown",
"definition": "Status of the validation of the target against the primary source (successful; failed; unknown).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "validation-status"
}
],
"strength": "required",
"description": "Status of the validation of the target against the primary source",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/validation-status"
}
}
},
{
"id": "VerificationResult.primarySource.validationDate",
"path": "VerificationResult.primarySource.validationDate",
"short": "When the target was validated against the primary source",
"definition": "When the target was validated against the primary source.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "VerificationResult.primarySource.canPushUpdates",
"path": "VerificationResult.primarySource.canPushUpdates",
"short": "yes | no | undetermined",
"definition": "Ability of the primary source to push updates/alerts (yes; no; undetermined).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "can-push-updates"
}
],
"strength": "required",
"description": "Ability of the primary source to push updates/alerts",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/can-push-updates"
}
}
},
{
"id": "VerificationResult.primarySource.pushTypeAvailable",
"path": "VerificationResult.primarySource.pushTypeAvailable",
"short": "specific | any | source",
"definition": "Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "push-type-available"
}
],
"strength": "required",
"description": "Type of alerts/updates the primary source can send",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/push-type-available"
}
}
},
{
"id": "VerificationResult.attestation",
"path": "VerificationResult.attestation",
"short": "Information about the entity attesting to information",
"definition": "Information about the entity attesting to information.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "VerificationResult.attestation.source",
"path": "VerificationResult.attestation.source",
"short": "The individual attesting to information",
"definition": "The individual attesting to information.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true
},
{
"id": "VerificationResult.attestation.organization",
"path": "VerificationResult.attestation.organization",
"short": "The organization attesting to information",
"definition": "The organization attesting to information.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true
},
{
"id": "VerificationResult.attestation.method",
"path": "VerificationResult.attestation.method",
"short": "Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)",
"definition": "Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "VerificationResult.attestation.date",
"path": "VerificationResult.attestation.date",
"short": "The date the information was attested to",
"definition": "The date the information was attested to.",
"min": 1,
"max": "1",
"type": [
{
"code": "date"
}
],
"isSummary": true
},
{
"id": "VerificationResult.attestation.sourceIdentityCertificate",
"path": "VerificationResult.attestation.sourceIdentityCertificate",
"short": "A digital identity certificate associated with the attestation source",
"definition": "A digital identity certificate associated with the attestation source.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "VerificationResult.attestation.proxyIdentityCertificate",
"path": "VerificationResult.attestation.proxyIdentityCertificate",
"short": "A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source",
"definition": "A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "VerificationResult.validator",
"path": "VerificationResult.validator",
"short": "Information about the entity validating information",
"definition": "Information about the entity validating information.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "VerificationResult.validator.identifier",
"path": "VerificationResult.validator.identifier",
"short": "URI of the validator",
"definition": "URI of the validator.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "VerificationResult.validator.organization",
"path": "VerificationResult.validator.organization",
"short": "Reference to the organization validating information",
"definition": "Reference to the organization validating information.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"id": "VerificationResult.validator.identityCertificate",
"path": "VerificationResult.validator.identityCertificate",
"short": "A digital identity certificate associated with the validator",
"definition": "A digital identity certificate associated with the validator.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "VerificationResult.validator.dateValidated",
"path": "VerificationResult.validator.dateValidated",
"short": "Date on which the validator last validated the information",
"definition": "Date on which the validator last validated the information.",
"min": 1,
"max": "1",
"type": [
{
"code": "date"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Release 4 Draft for Comment (Jan-2018 v3.2.0-12885) generated on Wed, Dec 20, 2017 15:58+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change